跳到主要內容

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

留言

這個網誌中的熱門文章

館長的網站技術瓶頸,小弟弟來解答 - notorious-2019.com

館長的網站技術瓶頸,小弟弟來解答 - notorious-2019.com 昨天看到館長的網站倒了,也看到館長說一個月花費大概一百萬左右的月費在支持這個架設的電商網站,也對外發布出來訊息,希望求救, 直接講結論 建議解法, 1. 首先要做的事情是讓整個網站可以橫向擴展 (Load Balancer + n 台伺服器),對,相信我,IIS 也是可以做 Scale out, 這是對於 Application layer 服務的解法。 2. 資料的部分 SQL 吞吐量,建議改成 GCP Cloud SQL, 或者就直接轉到 Azure SQL Server 環境上會相對容易解決 SQL 的問題。 上述 2 個步驟都處理完,其實 100 萬的費用,應該 20000 concurrent user 是沒有問題的,但前提是要設定『對』! 額外需要花較長期時間要處理的,建議就是在 Queue 的處理,購物車的狀態都可以進入到 Queue 再來處理 SQL insert 的問題,減少不斷的 insert / update 的狀態,後文會提到 ... 底下詳細的會再說明如何後後續還有哪些處理的細節。 這兩天剛好有個小空擋,就來分析一下狀況, 可以從外部讀取得到的服務大致上如下, ASP.Net : 4.0 IIS 10 + Windows (廢話) SQL Server (推測) OP Service: PleskWin Host: Google Cloud DNS: Cloudflare 前端服務內容架構 Server-side render, jQuery base, 推測有可能採用現成購物車來進行,看起來不太像是用 wooCommerce 比較像是 Cart Functionality 這類的項目直接搭建而成(當然這純屬猜測) 功能拆解 因為網站是透過 Server site render 所有頁面都需要重新透過伺服器進行載入,這樣的狀況,如果在頻繁忙碌的 eCommerce 網站架構下會是一個致命傷, 簡單來說,數量的查詢,特惠價,優惠碼等等資訊的處理,使用者每做一步都需要重新跳轉頁面,或者整頁面重新讀取,只是為了部分的資料更新,這些都可以抽取出來成為 API ,透過 AJAX 的方式進行讀取。 讀寫分離 在不了解目前資料庫複雜狀態下,首先要讓所有人都

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

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

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

直播錄影設備分享 蠻多朋友都在敲碗詢問,到底一場直播需要準備哪些設備,這邊聽筆者娓娓道來, 網路 好的網路上天堂,壞的網路會讓你掉落到不知道什麼地方。 會建議大家至少是一個獨立的 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 環形燈來說算是堪用,為什麼會說堪用,如果場景允許,實際上再加上左右補光會讓畫面呈現效果更佳。 目前上述的需求,都是以大頭照拍攝,或者半身的需求為主。 如果說要拍到全身的話,基本上就是直上攝影用補光燈,這就不在此範圍內