成人无码视频,亚洲精品久久久久av无码,午夜精品久久久久久毛片,亚洲 中文字幕 日韩 无码

資訊專欄INFORMATION COLUMN

每個(gè)PHPer都應(yīng)當(dāng)掌握的注釋標(biāo)記

quietin / 931人閱讀

摘要：簡介注釋標(biāo)簽在代碼注釋中的作用非常大，但是可能很多同學(xué)在平常開發(fā)中會(huì)忽略這些標(biāo)簽的作用，所以我這邊特地整理一些常用的注釋標(biāo)記，通過圖文展現(xiàn)形式，希望能幫助你能更好理解每個(gè)注釋標(biāo)簽的作用或許你離漂亮的代碼，就差一個(gè)標(biāo)簽項(xiàng)目工程地址被此標(biāo)記的

簡介

注釋標(biāo)簽在代碼注釋中的作用非常大，但是可能很多同學(xué)在平常開發(fā)中會(huì)忽略這些標(biāo)簽的作用，所以我這邊特地整理一些常用的注釋標(biāo)記，通過圖文展現(xiàn)形式，希望能幫助你能更好理解每個(gè)注釋標(biāo)簽的作用.

或許你離漂亮的代碼，就差一個(gè)標(biāo)簽^_^

項(xiàng)目工程地址 : https://github.com/yinggaozhen/doc-demo/tree/master/php

_

@deprecated

@deprecated : 被此標(biāo)記的函數(shù)或者成員方法表示下個(gè)版本將會(huì)被廢棄，告知適用方不再推薦使用此方法.

詳細(xì)代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/deprecated

語法 
@deprecated [] []
描述

@deprecated可以填寫一個(gè)版本號，版本號的規(guī)則同@version

如果被標(biāo)記的方法只是因?yàn)楸黄渌路椒ù娑粡U棄，可以結(jié)合@see來表示被代替的方法

標(biāo)簽效果

_

@inheritdoc

@inheritdoc : 文檔繼承,會(huì)繼承父類的文檔注釋.

詳細(xì)代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/inheritdoc

語法 
@inheritDoc
描述

@inheritDoc會(huì)繼承父類的所有文檔注釋.在繼承之后可以對指定字段進(jìn)行重寫

標(biāo)簽效果 1.直接繼承

2.繼承重寫

_

@internal

@internal : 被此標(biāo)簽標(biāo)記的內(nèi)部類/方法，作用范圍只能限于當(dāng)前文件，外部文件不可調(diào)用.

詳細(xì)代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/internal

語法 
@internal [description]
使用場景

此標(biāo)簽通?？墒褂迷趩卧獪y試中，比如在單元測試中定義了一個(gè)測試用的類，可對此測試類添加@internal標(biāo)簽，這樣別人在正常邏輯中萬一不小心錯(cuò)誤引用了測試類，在IDE的幫助下，可以第一時(shí)間得到反饋.

標(biāo)簽效果

_

@link

@link : 此標(biāo)簽可以引導(dǎo)你到指定的外部跳轉(zhuǎn)鏈接.

詳細(xì)代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/link

語法 
@link [URI] []
描述

該標(biāo)簽只有1個(gè)跳轉(zhuǎn)選項(xiàng)

@外部跳轉(zhuǎn)鏈接 : 必須是滿足RFC2396的跳轉(zhuǎn)鏈接,例如http://github.com/yinggaozhen

和@see的區(qū)別
- @see @link
外部鏈接 √ √
內(nèi)部程序 √ X

_

@see

@see : 此標(biāo)簽可以引導(dǎo)你到指定的外部跳轉(zhuǎn)鏈接/內(nèi)部程序.

詳細(xì)代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/see

語法 
@see [URI | FQSEN] []
描述

該標(biāo)簽可以有兩個(gè)跳轉(zhuǎn)選項(xiàng)

@外部跳轉(zhuǎn)鏈接 : 必須是滿足RFC2396的跳轉(zhuǎn)鏈接,例如http://github.com/yinggaozhen

@內(nèi)部程序鏈接 : 可以跳轉(zhuǎn)到制定的類/方法/變量，如class::method

和@link的區(qū)別
- @see @link
外部鏈接 √ √
內(nèi)部程序 √ X

_

@var

@var : 定義一個(gè)數(shù)據(jù)的類型.

詳細(xì)代碼演示 : 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/浮點(diǎn)數(shù)
object 對象實(shí)例
specifiedType 指定類
mixed 任意類型
array/specifiedType[] 數(shù)組，可以指定成指定類型的數(shù)組
resource 文件資源類型
void 無返回值
null -
callable 可執(zhí)行的回調(diào)函數(shù)
function 不一定能執(zhí)行的方法
self/$this 當(dāng)前實(shí)例
標(biāo)簽效果

實(shí)現(xiàn)@var可以有兩種使用方法

1.在類成員變量中定義，不需要指定變量名稱

2.直接給具體變量定義，需要指定變量名稱

_

@throws

@throws : 拋出一個(gè)異常，告訴調(diào)用方需要做好處理異常相關(guān)工作.

詳細(xì)代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/php/throws

語法 
@throws [Type] []
標(biāo)簽效果

_

最后

文章篇幅有限，這里列舉了一部分標(biāo)簽，更多標(biāo)簽可以通過以下工程地址

項(xiàng)目工程地址 : https://github.com/yinggaozhen/doc-demo/tree/master/php

標(biāo)簽會(huì)不定期持續(xù)更新，歡迎各位star & fork

您的支持是我更新的最大動(dòng)力~~

文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請注明本文地址：http://m.hztianpu.com/yun/31775.html

相關(guān)文章

  • 每一位JSer都應(yīng)當(dāng)掌握的注釋標(biāo)記

    摘要：表示該函數(shù)接受可變數(shù)量的參數(shù)，并指定一個(gè)類型的參數(shù)一個(gè)可選參數(shù)可選參數(shù)，默認(rèn)值指示參數(shù)是可選的。一個(gè)注釋塊中您可以包含多個(gè)標(biāo)簽。 簡介 注釋標(biāo)簽在代碼注釋中的作用非常大，但是可能很多同學(xué)在平常開發(fā)中會(huì)忽略這些標(biāo)簽的作用，所以我這邊特地整理一些常用的注釋標(biāo)記，通過圖文展現(xiàn)形式，希望能幫助你能更好理解每個(gè)注釋標(biāo)簽的作用. 想必掌握這些注釋標(biāo)簽之后，不光對您今后的自己代碼編寫，還是閱讀優(yōu)秀源...

    Salamander 評論0 收藏0

  • 通用 CSS 筆記、建議與指導(dǎo)

    摘要：如下區(qū)塊標(biāo)題前綴可以讓我們使用命令查找標(biāo)題名時(shí)將搜索范圍限制在區(qū)塊標(biāo)題中。 在參與規(guī)模龐大、歷時(shí)漫長且參與人數(shù)眾多的項(xiàng)目時(shí)，所有開發(fā)者遵守如下規(guī)則極為重要： 保持 CSS 易于維護(hù) 保持代碼清晰易懂 保持 CSS 的可拓展性 為了實(shí)現(xiàn)這一目標(biāo)，我們要采用諸多方法。 本文檔第一部分將探討語法、格式以及分析 CSS 結(jié)構(gòu)；第二部分將圍繞方法論、思維框架以及編寫與規(guī)劃 CSS 的看法...

    lushan 評論0 收藏0

  • Conflux & TokenGazer AMA活動(dòng)內(nèi)容回顧

    摘要：安全性不可更改性排序結(jié)果不能被壞人的攻擊更改。這也是很嚴(yán)重的公鏈安全事故?？偠灾?，通過設(shè)計(jì)安全的拓?fù)渑判蛩惴ǎ鉀Q交易順序問題。區(qū)塊排序的一致可以保證無效交易標(biāo)記的一致。樞軸鏈和分叉鏈的區(qū)塊獎(jiǎng)勵(lì)計(jì)算規(guī)則是一致的。 showImg(https://segmentfault.com/img/remote/1460000017710155?w=893&h=380); 12月27日，Conf...

    littlelightss 評論0 收藏0

  • Conflux & TokenGazer AMA活動(dòng)內(nèi)容回顧

    摘要：安全性不可更改性排序結(jié)果不能被壞人的攻擊更改。這也是很嚴(yán)重的公鏈安全事故。總而言之，通過設(shè)計(jì)安全的拓?fù)渑判蛩惴ǎ鉀Q交易順序問題。區(qū)塊排序的一致可以保證無效交易標(biāo)記的一致。樞軸鏈和分叉鏈的區(qū)塊獎(jiǎng)勵(lì)計(jì)算規(guī)則是一致的。 showImg(https://segmentfault.com/img/remote/1460000017710155?w=893&h=380); 12月27日，Conf...

    DesGemini 評論0 收藏0

發(fā)表評論

0條評論

最新活動(dòng)
閱讀需要支付1元查看
<