1. 程式人生 > >給php程式碼新增規範的註釋

給php程式碼新增規範的註釋


在phpdocumentor中,註釋分為文件性註釋和非文件性註釋。
所謂文件性註釋,是那些放在特定關鍵字前面的多行註釋,特定關鍵字是指能夠被phpdoc分析的關鍵字,例如class,var等,具體的可參加附錄1.
那些沒有在關鍵字前面或者不規範的註釋就稱作非文件性註釋,這些註釋將不會被phpdoc所分析,也不會出現在你產生的api文當中。
3.2如何書寫文件性註釋:
所 有的文件性註釋都是由/**開始的一個多行註釋,在phpDocumentor裡稱為DocBlock, DocBlock是指軟體開發人員編寫的關於某個關鍵字的幫助資訊,使得其他人能夠通過它知道這個關鍵字的具體用途,如何使用。 PhpDocumentor規定一個DocBlock包含如下資訊:


1. 功能簡述區
2. 詳細說明區
3. 標記tag
文件性註釋的第一行是功能描述區,正文一般是簡明扼要地說明這個類,方法或者函式的功能,功能簡述的正文在生成的文件中將顯示在索引區。功能描述區的內容可以通過一個空行或者 . 來結束
在 功能描述區後是一個空行,接著是詳細說明區,. 這部分主要是詳細說明你的API的功能,用途,如果可能,也可以有用法舉例等等。在這部分,你應該著重闡明你的API函式或者方法的通常的用途,用法,並 且指明是否是跨平臺的(如果涉及到),對於和平臺相關的資訊,你要和那些通用的資訊區別對待,通常的做法是另起一行,然後寫出在某個特定平臺上的注意事項 或者是特別的資訊,這些資訊應該足夠,以便你的讀者能夠編寫相應的測試資訊,比如邊界條件,引數範圍,斷點等等。

之後同樣是一個空白行,然後是文件的標記tag,指明一些技術上的資訊,主要是最主要的是呼叫引數型別,返回值極其型別,繼承關係,相關方法/函式等等。

文件註釋中還可以使用例如<b> <code>這樣的標籤

5.文件標記:
文件標記的使用範圍是指該標記可以用來修飾的關鍵字,或其他文件標記。
所有的文件標記都是在每一行的 * 後面以@開頭。如果在一段話的中間出來@的標記,這個標記將會被當做普通內容而被忽略掉。
6.一些註釋規範
a.註釋必須是
/**
* XXXXXXX
*/
的形式
b.對於引用了全域性變數的函式,必須使用glboal標記。
c.對於變數,必須用var標記其型別(int,string,bool...)

d.函式必須通過param和return標記指明其引數和返回值
e.對於出現兩次或兩次以上的關鍵字,要通過ingore忽略掉多餘的,只保留一個即可
f.呼叫了其他函式或類的地方,要使用link或其他標記連結到相應的部分,便於文件的閱讀。
g.必要的地方使用非文件性註釋,提高程式碼易讀性。
h.描述性內容儘量簡明扼要,儘可能使用短語而非句子。

i.全域性變數,靜態變數和常量必須用相應標記說明

<?php
/**
* @name 名字
* @abstract 申明變數/類/方法
* @access 指明這個變數、類、函式/方法的存取許可權
* @author 函式作者的名字和郵箱地址
* @category  組織packages
* @copyright 指明版權資訊
* @const 指明常量
* @deprecate 指明不推薦或者是廢棄的資訊MyEclipse編碼設定
* @example 示例
* @exclude 指明當前的註釋將不進行分析,不出現在文擋中
* @final 指明這是一個最終的類、方法、屬性,禁止派生、修改。
* @global 指明在此函式中引用的全域性變數
* @include 指明包含的檔案的資訊
* @link 定義線上連線
* @module 定義歸屬的模組資訊
* @modulegroup 定義歸屬的模組組
* @package 定義歸屬的包的資訊
* @param 定義函式或者方法的引數資訊
* @return 定義函式或者方法的返回資訊
* @see 定義需要參考的函式、變數,並加入相應的超級連線。
* @since 指明該api函式或者方法是從哪個版本開始引入的
* @static 指明變數、類、函式是靜態的。
* @throws 指明此函式可能丟擲的錯誤異常,極其發生的情況
* @todo 指明應該改進或沒有實現的地方
* @var 定義說明變數/屬性。
* @version 定義版本資訊
*/
function XXX($a){..}

<?php
/**
* Sample File 2, phpDocumentor Quickstart
*
* This file demonstrates the rich information that can be included in
* in-code documentation through DocBlocks and tags.
* @author Greg Beaver <[email protected]>
* @version 1.0
* @package sample
*/
  
//PHP code
  
/**
* A sample function docblock
* @global string document the fact that this function uses $_myvar
* @staticvar integer $staticvar this is actually what is returned
* @param string $param1 name to declare
* @param string $param2 value of the name
* @return integer
*/
function firstFunc($param1, $param2 = 'optional') {
    static $staticvar = 7;
    global $_myvar;
    return $staticvar;
}

相關推薦

php程式碼新增規範註釋

在phpdocumentor中,註釋分為文件性註釋和非文件性註釋。所謂文件性註釋,是那些放在特定關鍵字前面的多行註釋,特定關鍵字是指能夠被phpdoc分析的關鍵字,例如class,var等,具體的可參加附錄1.那些沒有在關鍵字前面或者不規範的註釋就稱作非文件性註釋,這些註

php程式碼新增規範註釋phpDocumentor

 給php程式碼新增規範的註釋在phpdocumentor中,註釋分為文件性註釋和非文件性註釋。所謂文件性註釋,是那些放在特定關鍵字前面的多行註釋,特定關鍵字是指能夠被phpdoc分析的關鍵字,例如class,var等,具體的可參加附錄1.那些沒有在關鍵字前面或者不規範

python程式碼新增logging 的方式

# -*- coding: utf-8 -*- __author__ = 'jennyzhang' import logging class Config(): # 建立一個logger logger = logging.getLogger('statisticNew') l

PHP 程式碼風格規範 PSR-2 (中文版)

PHP 程式碼風格規範 PSR-2 本篇規範是 PSR-1 基本程式碼規範的繼承與擴充套件。 本規範希望通過制定一系列規範化PHP程式碼的規則,以減少在瀏覽不同作者的程式碼時,因代 碼風格的不同而造成不便。 當多名程式設計師在多個專案中合作時,就需要一個共同的編碼規範, 而本文中的風格規範源自 於多個不同專案

如何使用PDF編輯軟體PDF檔案新增文字註釋

  現在PDF檔案使用的越來越普遍了,PDF檔案在我們日常的工作中,甚至生活中都會使用的到,PDF檔案的修改是需要使用PDF編輯軟體,那麼,如何使用PDF編輯軟體給PDF檔案新增文字註釋呢,不會的小夥伴可以跟小編一起來看看下面的文章,沒準就知道該怎樣操作了哦。    

source insight新增doxygen註釋風格

    目前專案組對於註釋的要求比較高,導致我添加註釋的時候非常煩,大量的重複勞動確實很煩人,自己也一直打算給source insight新增類似的功能,可能是本人比較懶,一直不想做這樣的工作。不過,既然可以一勞永逸,何樂而不為呢。     後來發現有個叫doxygen的工

Python:圖形中新增文字註釋(text函式)

以下這個案例,基本上是我們平時註釋用的最多的,其基本思想就是,找到你想要註釋的那個位置,進行註釋,有的時候可以覺得用定死的方式來做,顯示出的效果也會很好。 平時可以多看看官網教程:text #!/usr/bin/python #coding: utf-8

PHP程式碼註釋規範

PHPDocumentor是一個用PHP寫的工具,對於有規範註釋的php程式,它能夠快速生成具有相互參照,索引等功能的API文件。老的版本是 phpdoc。 1. 什麼是phpDocumentor ? PHPDocumentor 是一個用PHP寫的工具,對於有規範註釋的php程式,它能

[Xcode10 實際操作]九、實用進階-(3)程式碼方法新增巨集註釋

本文將演示如何在方法列表中,對方法名稱進行註釋。 這樣可以使程式,按功能分塊,使方法清晰、易讀並且方便定位。 在專案導航區,開啟檢視控制器的程式碼檔案【ViewController.swift】 1 import UIKit 2 3 class ViewController: UIVi

vs2012及以上版本中寫c++時自動程式碼新增建立資訊註釋的問題

寫多了,就煩了,如果系統能自動生成就好了。 確實在寫java等語言時,能輕鬆做到這些,甚至包括生成實時的日期時間,當前的檔名等其他同步資訊。 然而在vs上,對C#能完成這些設定,但是對c++卻沒那麼給力了。 你可能在網上見到很多如下說法: 在VS安裝

[iOS]一行程式碼中文陣列新增索引

/** * 將原資料以及存放索引的空陣列 傳參 返回整理後的陣列 * 已用分類封裝,直接引入標頭檔案 使用方法即可 * * https://github.com/KKKKaras/JY_SectionDemo */ #import "JYTableViewController.h

php類的方法註釋規範

一個好的註釋有非常大的作用,符合規範的註釋,在呼叫時,編輯器會直接顯示註釋資訊,這樣能增加團隊協作的速度和能力。註釋規範如下。 /** * 方法描述 * @access private * @author AT路遙 * @version 1.0 * @par

如何規範自己的php程式碼

前言 上段時間一個老外因為隊友程式碼不規範,不使用駝峰命名,掏出槍幹掉了自己的隊友。嚇的我趕緊看了一遍PSR(PHP Standards Recommendations)規範。 PSR官網 GitHub上的PSR PSR有PSR-0,PSR-1,PSR-2,PSR-3,P

PHP 程式碼註釋解釋

@access 使用範圍:class,function,var,define,module 該標記用於指明關鍵字的存取許可權:private、public或proteced @author 指明作者 @copyright 使用範圍:class,function,var,define,module,u

pycharm技巧:選中的程式碼新增括號/引號

這個功能在pycharm裡是預設關閉的,開啟的方式是: File->Settings->Editor->General->Smart Keys,找到Surround selection on typing quote or brace 點選即可。 File->S

IDA實戰分析教程初級篇第一課:程式碼添加註釋

各位童鞋大家好,我是小HUA,從今天開始,我將給大家帶來一系列的逆向分析教程,希望大家能夠分享逆向的快樂,本身技術有限,希望大家不要噴我。也希望大家能夠分享自己的技術,為中國夢奮鬥! 今天我們開始學習IDA實戰分析基礎篇第一課,從基礎開始,一點點深入,這樣才會能夠走得更遠

sql server2008資料表,欄位,新增修改註釋

 1、sqlserver用語句給表註釋 EXECUTE sp_addextendedproperty N'MS_Description', N'表註釋', N'user', N'dbo', N'table', N'表名', NULL, NULL 2、sqlserver用語句給表的“欄位”註釋 EXECUT

如何寫PHP規範註釋

轉載自:http://hi.baidu.com/leo5210/item/291877ea5f125c345b7cfb83 所有的文件標記都是在每一行的 * 後面以@開頭。如果在一段話的中間出來@的標記,這個標記將會被當做普通內容而被忽略掉。 @access      

APP提供支付寶支付簽名PHP程式碼

//$no 是訂單編號  $price 是價格 function ali_pay($no, $price){     $data['subject'] = '訂單'.$no;     $data['out_trade_no'] = 訂單號;     $data['tota

PHP程式碼Git提交前新增 phpcs 語法檢查

1.安裝phpcssudo apt install php-codesniffer設定標準phpcs --config-set default_standard PSR2設定編碼phpcs --config-set encoding utf-82.git整合提交前程式碼檢查開