跳到主要內容

[轉貼] JSDoc 及 PHPDocument 註解撰寫差異

本篇文章轉貼自: 林中路 - JSDoc 與 phpDocumentor


JSDoc
  • @fileoverview :  檔案描述, 鷹置於檔案開始.
  • @author : 作者. 我寫我, 你寫你.
  • @version : 指定版本訊息.
  • @see : 建立一個鏈結,指出相關於的類別描述文件.
  • @require : 建立一個鏈結,指出必要的類別描述文件.
  • @deprecated :
  • @param : 參數說明.
  • @argument : 引數說明.
  • @return : 返回值說明.
  • @throws :
  • @exception :
  • @private :
  • @final : 常數值說明.
  • @ignore : 忽略此函式.
  • @class : 類別說明.
  • @constructor : 初始建構式說明.
  • @type : 返回值類型說明.
  • @extends : 繼承說明.
phpDocumentor
  • @abstract : 抽象類型的標記說明. 使用範圍 method, class variable, class 等.
  • @access : 標記可駐明關鍵字的存取權限:private、public 或 proteced. 使用範圍 class, function, var, define, module 等.
  • @author : 作者. 我寫我, 你寫你.
  • @category :
  • @copyright : 版權註解, 使用範圍 class, function, var, define, module, use 等.
  • @deprecated : 棄用標示, 使用範圍 class, function, var, define, module, constent, global, include 等.
  • @example : 高亮顯示註解文字段落,
  • @const : 標示定義的常量, 使用範圍 define.
  • @final : 完成, 可用來標明此關鍵字為最終的完成狀態 (有些文件說可以禁止派生與修改, 這可能嗎?). 使用範圍 class, function, var 等.
  • @filesource : 類似 example, 直接讀取當前解析的php文件的內容並顯示.
  • @global : 全局變量.
  • @ingore : 忽略指定的關鍵字.
  • @license : 標記授權 URL 與內容.
  • @link : 類似 @license, 作用就如 html 相似.
  • @name : 名稱註解.
  • @package :
  • @param : 函數的引數或參數說明.
  • @return : 返回值或狀態說明.
  • @see : 參考連結.
  • @since :
  • @static :
  • @staticvar : 靜態說明.
  • @subpackage :
  • @var datatype description : 變數與變數類型說明.
  • @todo information string [unspecified format] : 功能規劃性遞變說明.
  • @uses  file.ext|elementname|class::methodname()|class::$variablename|functionname()|function functionname description of how the element is used : 使用方式說明
  • @version : versionstring [unspecified format], 版本說明.

留言

這個網誌中的熱門文章

[解釋] uuid 與 guid 的差異

uuid 與 guid 的差異 很多人都有使用過 MySQL 的 number auto increment, 可是實際使用之後就會發現,很快的數字會不夠使用,而且這個 id 是很容易被猜測出來連續性。 因此就開始進行了解,看到了 uuid 這個名詞,進而下去查詢發現 guid 的另外這個名詞,感覺上這兩個名詞似乎是有些什麼特殊關連。 這篇文章就小小記錄一下自己的查詢心得。

[分享] 腳踏車環島注意事項

很多人都期望自己能夠做點什麼,做些什麼,而退伍之後的第二個星期,就展開了環島之旅。 對很多人來說這不算什麼,甚至有人展開了走路、跑步、溜滑板、單輪車等方式環島一周,充分展現對台灣的愛與關懷。 這篇主要讓不知道怎麼準備環島的人,作一個完善的解說,首先隨身的東西要有: 證件現金類 : 身份證 健保卡 學生證 現金 提款卡 悠遊卡

[教學] 快快樂樂刪除CodeIgniter index.php

預設的CI網址預設都設定為index.php同一層級,因此所有的程式都必須指定index.php導向才能開始,例如 http://localhost/ci/index.php/welcome/test http://localhost/ci/welcome/test 本文將說明如何將惱人的index.php消除,還你一個漂亮的URL。 設定開始: 接下來說明如何使用rewrite方式將惱人的index.php去除。 rewrite不清楚的人,煩請先自行google 首先要先確定Apache的 mod_rewrite 有 開啟 ,如果沒有開啟請設定好之後重新啟動apache。 接著,在根目錄底下建立一個新檔案,檔名為 .htaccess ,裡面程式碼如下: <IfModule mod_rewrite.c> RewriteEngine On RewriteBase / RewriteCond %{REQUEST_FILENAME} !-f RewriteCond %{REQUEST_FILENAME} !-d RewriteRule ^(.*)$ index.php/$1 [L] </IfModule> 接著到 application/config/config.php ,開啟檔案修改 $config['index_page'] = ""; 注意: /index.php/$1 要根據你目錄,例如 http://localhost/index.php ,網站根目錄為 /ci/index.php 則要寫成 /ci/index.php/$1 接著至CI目錄下,尋找 config\config.php , 修改一下裡面的檔案,修改如下: $config['index_page'] = ""; 存檔後,如此一來大功告成。 參考資料 官方網站說明