華為java編程規(guī)范---------java 編程規(guī)范

2019-11-06 07:51:07

字體：大中小

來源：轉載

供稿：網(wǎng)友

俗話說，看別人的代碼是件痛苦的事，同樣，讀自己的代碼也是件痛苦的事。幾個月前寫的喳喳，現(xiàn)在拿出來看，簡直一頭霧水。這個引用是什么意思？這個方法是干啥的？這個類是干啥的？為什么要這么實現(xiàn)？等等。這個時候要是有清晰明了的注釋就簡直太爽。所以，為了不讓自己浪費太多時間去回想，去猜代碼意思。因而不得不養(yǎng)成良好的注釋習慣。

一、注釋

1.1 規(guī)則

一般情況下，源程序有效注釋量必須在30%以上。注釋的原則是有利于程序的閱讀理解，在該加的地方都加了，注釋太多也不要太少，注釋語言必須準確，易懂，簡潔。

1.2包的注釋

包的注釋寫入一個名為package.html的HTML格式說明文件放入當前路徑（為方便javaDoc收集）

示例：com/huawei/relay/com/pavkage.html

1.2.1包的注釋內(nèi)容

簡述本包作用、詳細描述本包的內(nèi)容、產(chǎn)品模塊名稱和版本、公司版權

示例：

<html><body><p>為relay 提供通信類，上層業(yè)務使用本包的通信類與Sp通信//一句話簡述<p>詳細描述。。。。。<p>MCSC V100R002 Relay<br>(C) 版權所有  2002 -2007 華為技術有限公司</body></html>1.3文件（內(nèi)）注釋
文件注釋寫入文件頭部，包名之前的位置。注意要以/*開始，避免被javaDoc收集
示例：
/*文件名：LogManager.java版權：Copyright 2002-2007 描述： MCSC V100R002  Relay  通用日志系統(tǒng)修改人：張三修改時間：2002/1/1修改內(nèi)容：新增*/1.3.1類和接口的注釋
該注釋放在package關鍵字之后，class或interface關鍵字之前。方便JavaDoc收集。
示例：
package com.huawei.msg.relay.com;/**LogManager 類集中控制對日志的讀寫操作*@author 李四 張三*@version *@模塊版本*/public class LogManager1.3.1類屬性、共有和保護方法注釋。寫在類屬性，共有和保護方法的上面。
示例：
/*注釋內(nèi)容*/PRivate String logType;/**根據(jù)日志類型和時間讀取日志（一句話功能簡述）*分配對應日志類型的logReaer，指定類型，查詢事件，條件和反復器緩沖數(shù)。讀取日志記錄，查詢條件為null或0時，表示無限制。*@return buferNum   日志緩沖器記錄數(shù)*/public void  lorReader(String logType , Date startTime , Date enTime , String userName){    //注釋  注釋應當與所描述的內(nèi)容進行同樣的縮進    CodeBlock one;    //注釋  注意將注釋與其上面的代碼用空行隔開    CodeBlock two;}
1.3.1變量的定義和分支語句塊
示例：
//如果 receiveFlag 為真if（receiveFlag）{    program codel;    while(...){        program code2;    }//end of while(index < MAX_INDEX)}//end of if(...) //指明是if語句結束。*在程序塊結束行右方加注釋標記，以表明某程序塊的結束。