資訊專欄INFORMATION COLUMN
摘要：簡介注釋標簽在代碼注釋中的作用非常大，但是可能很多同學在平常開發(fā)中會忽略這些標簽的作用，所以我這邊特地整理一些常用的注釋標記，通過圖文展現形式，希望能幫助你能更好理解每個注釋標簽的作用或許你離漂亮的代碼，就差一個標簽項目工程地址被此標記的
簡介
注釋標簽在代碼注釋中的作用非常大，但是可能很多同學在平常開發(fā)中會忽略這些標簽的作用，所以我這邊特地整理一些常用的注釋標記，通過圖文展現形式，希望能幫助你能更好理解每個注釋標簽的作用.
或許你離漂亮的代碼，就差一個標簽^_^
項目工程地址 : https://github.com/yinggaozhen/doc-demo/tree/master/php
_
@deprecated@deprecated : 被此標記的函數或者成員方法表示下個版本將會被廢棄，告知適用方不再推薦使用此方法.
詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/deprecated
語法@deprecated [描述] [ ]
@deprecated可以填寫一個版本號，版本號的規(guī)則同@version
如果被標記的方法只是因為被其他新方法代替而被廢棄，可以結合@see來表示被代替的方法
標簽效果_
@inheritdoc@inheritdoc : 文檔繼承,會繼承父類的文檔注釋.
詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/inheritdoc
語法@inheritDoc描述
@inheritDoc會繼承父類的所有文檔注釋.在繼承之后可以對指定字段進行重寫
標簽效果 1.直接繼承 2.繼承重寫_
@internal@internal : 被此標簽標記的內部類/方法，作用范圍只能限于當前文件，外部文件不可調用.
詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/internal
語法@internal [description]使用場景
此標簽通?？墒褂迷趩卧獪y試中，比如在單元測試中定義了一個測試用的類，可對此測試類添加@internal標簽，這樣別人在正常邏輯中萬一不小心錯誤引用了測試類，在IDE的幫助下，可以第一時間得到反饋.
標簽效果_
@link@link : 此標簽可以引導你到指定的外部跳轉鏈接.
詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/link
語法@link [URI] [描述]
該標簽只有1個跳轉選項
@外部跳轉鏈接 : 必須是滿足RFC2396的跳轉鏈接,例如http://github.com/yinggaozhen
和@see的區(qū)別| - | @see | @link |
|---|---|---|
| 外部鏈接 | √ | √ |
| 內部程序 | √ | X |
_
@see@see : 此標簽可以引導你到指定的外部跳轉鏈接/內部程序.
詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/see
語法@see [URI | FQSEN] [描述]
該標簽可以有兩個跳轉選項
@外部跳轉鏈接 : 必須是滿足RFC2396的跳轉鏈接,例如http://github.com/yinggaozhen
@內部程序鏈接 : 可以跳轉到制定的類/方法/變量，如class::method
和@link的區(qū)別| - | @see | @link |
|---|---|---|
| 外部鏈接 | √ | √ |
| 內部程序 | √ | X |
_
@var@var : 定義一個數據的類型.
詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/var
語法@var [Type] [$element_name] [變量列表]
| 變量類型 | 說明 |
|---|---|
| string | 字符串 |
| integer/int | number/int類型 |
| boolean/bool | false/true |
| float/double | number/浮點數 |
| object | 對象實例 |
| specifiedType | 指定類 |
| mixed | 任意類型 |
| array/specifiedType[] | 數組，可以指定成指定類型的數組 |
| resource | 文件資源類型 |
| void | 無返回值 |
| null | - |
| callable | 可執(zhí)行的回調函數 |
| function | 不一定能執(zhí)行的方法 |
| self/$this | 當前實例 |
實現@var可以有兩種使用方法
1.在類成員變量中定義，不需要指定變量名稱 2.直接給具體變量定義，需要指定變量名稱_
@throws@throws : 拋出一個異常，告訴調用方需要做好處理異常相關工作.
詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/throws
語法@throws [Type] [標簽效果]
_
最后文章篇幅有限，這里列舉了一部分標簽，更多標簽可以通過以下工程地址
項目工程地址 : https://github.com/yinggaozhen/doc-demo/tree/master/php
標簽會不定期持續(xù)更新，歡迎各位star & fork
您的支持是我更新的最大動力~~
文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規(guī)行為，您可以聯系管理員刪除。
轉載請注明本文地址：http://www.ezyhdfw.cn/yun/31775.html
摘要：表示該函數接受可變數量的參數，并指定一個類型的參數一個可選參數可選參數，默認值指示參數是可選的。一個注釋塊中您可以包含多個標簽。 簡介 注釋標簽在代碼注釋中的作用非常大，但是可能很多同學在平常開發(fā)中會忽略這些標簽的作用，所以我這邊特地整理一些常用的注釋標記，通過圖文展現形式，希望能幫助你能更好理解每個注釋標簽的作用. 想必掌握這些注釋標簽之后，不光對您今后的自己代碼編寫，還是閱讀優(yōu)秀源...
摘要：如下區(qū)塊標題前綴可以讓我們使用命令查找標題名時將搜索范圍限制在區(qū)塊標題中。 在參與規(guī)模龐大、歷時漫長且參與人數眾多的項目時，所有開發(fā)者遵守如下規(guī)則極為重要： 保持 CSS 易于維護 保持代碼清晰易懂 保持 CSS 的可拓展性 為了實現這一目標，我們要采用諸多方法。 本文檔第一部分將探討語法、格式以及分析 CSS 結構；第二部分將圍繞方法論、思維框架以及編寫與規(guī)劃 CSS 的看法...
摘要：安全性不可更改性排序結果不能被壞人的攻擊更改。這也是很嚴重的公鏈安全事故?？偠灾ㄟ^設計安全的拓撲排序算法，解決交易順序問題。區(qū)塊排序的一致可以保證無效交易標記的一致。樞軸鏈和分叉鏈的區(qū)塊獎勵計算規(guī)則是一致的。 showImg(https://segmentfault.com/img/remote/1460000017710155?w=893&h=380); 12月27日，Conf...
摘要：安全性不可更改性排序結果不能被壞人的攻擊更改。這也是很嚴重的公鏈安全事故。總而言之，通過設計安全的拓撲排序算法，解決交易順序問題。區(qū)塊排序的一致可以保證無效交易標記的一致。樞軸鏈和分叉鏈的區(qū)塊獎勵計算規(guī)則是一致的。 showImg(https://segmentfault.com/img/remote/1460000017710155?w=893&h=380); 12月27日，Conf...
閱讀 2693·2023-04-26 03:00
閱讀 1485·2021-10-12 10:12
閱讀 4330·2021-09-22 15:33
閱讀 2997·2021-09-22 15:06
閱讀 1595·2019-08-30 15:44
閱讀 2202·2019-08-30 13:59
閱讀 577·2019-08-30 11:24
閱讀 2480·2019-08-29 17:07
