站長資訊網(wǎng)
注釋編碼規(guī)范：1、所有導出對象都需要注釋說明其用途；非導出對象根據(jù)情況進行注釋。2、如果對象可數(shù)且無明確指定數(shù)量的情況下，一律使用單數(shù)形式和一般進行時描述；否則使用復數(shù)形式。3、包、函數(shù)、方法和類型的注釋說明都是一個完整的句子。4、句子類型的注釋首字母均需大寫；短語類型的注釋首字母需小寫。5、注釋的單行長度不能超過80個字符。
php入門到就業(yè)線上直播課：進入學習
Apipost = Postman + Swagger + Mock + Jmeter 超好用的API調試工具：點擊使用
本教程操作環(huán)境：windows7系統(tǒng)、GO 1.18版本、Dell G3電腦。
注釋的意義
-
注釋可以幫我們很好的完成文檔的工作，寫得好的注釋可以方便我們以后的維護。
-
/**/的塊注釋和//的單行注釋兩種注釋風格， 在我們的項目中為了風格的統(tǒng)一，全部使用單行注釋，注釋的質量決定了生成的文檔的質量。
注釋規(guī)范
-
所有導出對象都需要注釋說明其用途；非導出對象根據(jù)情況進行注釋。
-
如果對象可數(shù)且無明確指定數(shù)量的情況下，一律使用單數(shù)形式和一般進行時描述；否則使用復數(shù)形式。
-
包、函數(shù)、方法和類型的注釋說明都是一個完整的句子。
-
句子類型的注釋首字母均需大寫；短語類型的注釋首字母需小寫。
-
注釋的單行長度不能超過80個字符。
1、包級別
包級別的注釋就是對包的介紹，只需在同個包的任一源文件中說明即可有效?！?/p>
