註釋規範

来源:http://www.cnblogs.com/shouce/archive/2016/03/18/5290679.html
-Advertisement-
Play Games


 @access
使用範圍:class,function,var,define,module
該標記用於指明關鍵字的存取許可權:private、public或proteced
@author
指明作者
@copyright
使用範圍:class,function,var,define,module,use
指明版權信息
@deprecated
使用範圍:class,function,var,define,module,constent,global,include
指明不用或者廢棄的關鍵字
@example
該標記用於解析一段文件內容,並將他們高亮顯示。Phpdoc會試圖從該標記給的文件路徑中讀取文件內容
@const
使用範圍:define
用來指明php中define的常量
@final
使用範圍:class,function,var
指明關鍵字是一個最終的類、方法、屬性,禁止派生、修改。
@filesource
和example類似,只不過該標記將直接讀取當前解析的php文件的內容並顯示。
@global
指明在此函數中引用的全局變數
@ingore
用於在文檔中忽略指定的關鍵字
@license
相當於html標簽中的<a>,首先是URL,接著是要顯示的內容
例如<a href=”http://www.baidu.com”>百度</a>
可以寫作 @license http://www.baidu.com 百度
@link
類似於license
但還可以通過link指到文檔中的任何一個關鍵字
@name
為關鍵字指定一個別名。
@package
使用範圍:頁面級別的-> define,function,include
類級別的->class,var,methods
用於邏輯上將一個或幾個關鍵字分到一組。
@abstrcut
說明當前類是一個抽象類
@param
指明一個函數的參數
@return
指明一個方法或函數的返回指
@static
指明關建字是靜態的。
@var
指明變數類型
@version
指明版本信息
@todo
指明應該改進或沒有實現的地方
@throws
指明此函數可能拋出的錯誤異常,極其發生的情況
上面提到過,普通的文檔標記標記必須在每行的開頭以@標記,除此之外,還有一種標記叫做inline tag,用{@}表示,具體包括以下幾種:
{@link}
用法同@link
{@source}
顯示一段函數或方法的內容

 

   
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 還是看例子 會net都會看懂 不解釋
  • 學習asp.net mvc5心得
  • 在一個控制器中,它有很幾個視圖,在視圖中有一個菜單。點擊某一菜單,它分切換至對應的視圖,當前的視圖的菜單要高亮顯示。這個要求,也有許多網友問過Insus.NET。今天決定做一個例子,供大家學習與參考。先看看效果: 上圖中,當瀏覽China的視圖時,China這行菜單是Active的,其它沒有效果,依
  • <!doctype html> <html> <head> <title>PHP函數小展示</title> </head> <body> <?php //函數定義 function name(){ echo "這是一個無參函數"; } name();//無參函數調用 function name($a
  • 在多線程的情況下,如何得到線程安全的單利模式?synchronized,內部靜態類,序列化與反序列化,靜態代碼塊,enum枚舉,多種方式總結
  • Apple 在 iOS 提供了文件共用(FileSharing)功能,讓 App 有一個對外視窗的目錄,透過 iTunes 可以任意管理這個目錄的文檔內容(可拖入文檔,也能將文檔拖出備份)。 如果 App 需要文件共用,只需要在 Delphi 的 Project Option 需要加入 UIFile
  • Linux下,當我們用mysql c api 去操作mysqldb的時候,預設情況下,程式會以Latin1這種字元集去進行sql操作,這種情況,很可能就會出現亂碼, 比如,資料庫設置的字元集是utf8, 然後我們通過程式向其中插入一條記錄,然後我們去查詢的時候,就會出現亂碼。 為瞭解決這個問題,我們
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...