跳到主要內容

[轉貼] 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], 版本說明.

留言

這個網誌中的熱門文章

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

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

直播錄影設備大公開 - 從線下轉線上到底要哪些裝備

直播錄影設備分享 蠻多朋友都在敲碗詢問,到底一場直播需要準備哪些設備,這邊聽筆者娓娓道來, 網路 好的網路上天堂,壞的網路會讓你掉落到不知道什麼地方。 會建議大家至少是一個獨立的 4G 訊號,意味著當下至少要有 30MB/s 的上傳下載,這樣在透過 Google Meet / Zoom 視訊會議的時候是比較不會卡頓的狀態。 Google Meet 輔助文件 有提到關於頻寬的最低需求, 對位於 8.8.8.8. 的 Google 公用 DNS 伺服器執行連線偵測 (ping) 測試時,延遲時間應低於 50 毫秒。 參與者的上傳訊號 (無論通訊人數多寡) 應符合 3.2 mbps 的頻寬需求。 抓在這樣的標準之上會是比較穩定的, 如果你的需求是要透過 OBS 同時播出到 youtube live / Facebook live 和多個頻道的時候,會建議需要更高頻寬,最好是連接有線網路的狀況下尤佳。 總之,網路越快越好,直接光纖肯定沒錯!(可惜我家無法 …T_T 麥克風 直接說答案,這邊採用的是   Rode Wireless go 購買網址: https://24h.pchome.com.tw/prod/DGCF07-A900B6O2U 沒有考慮類似圓剛 av310 或者 BlueYite 之類的,主要是因為可能當初規劃會有起身轉場可能,且可以支援一對多的方式進行訪談式收音。 但很可惜的是,沒有朋友!(威 Rode Wireless go 的優勢在於內建獨立麥克風,可直接夾在領夾上,或者連接更好的收音麥克風,當作訊號源來處理,可變化性蠻大的,但對於聲音細緻度,可能就沒辦法要求到這麼多,總之是不同面向考量下的選擇。 燈光 首先燈光會比攝影機要重要許多許多許多,一個好的麥克風,加上好的燈光,基本上背景只要稍微設置一下,就可以美美搭。 6 寸桌上型 LED 網美燈 購買網址: https://24h.pchome.com.tw/prod/DGCF2O-A900AFG98?fq=/S/DGCF2O 道蝦皮找應該可以找到許多更便宜的,以目前來說 6 寸網美 LED 環形燈來說算是堪用,為什麼會說堪用,如果場景允許,實際上再加上左右補光會讓畫面呈現效果更佳。 目前上述的需求,都是以大頭照拍攝,或者半身的需求為主。 如果說要拍到全身的話,基本上就是直上攝影用補光燈,這就不在此範圍內

[教學] 快快樂樂刪除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'] = ""; 存檔後,如此一來大功告成。 參考資料 官方網站說明