Java代碼正文標准詳解。本站提示廣大學習愛好者：（Java代碼正文標准詳解）文章只能為提供參考，不一定能成為您想要的結果。以下是Java代碼正文標准詳解正文
代碼附有正文對法式開辟者來講異常主要，跟著技巧的成長，在項目開辟進程中，必需請求法式員寫好代碼正文，如許有益於代碼後續的編寫和應用。
根本的請求：
1、正文情勢同一
在全部運用法式中，應用具有分歧的標點和構造的款式來結構正文。假如在其它項目中發明它們的正文標准與這份文檔分歧，依照這份標准寫代碼，不要試圖在既成的標准體系中引入新的標准。
2、正文內容精確簡練
內容要簡略、清楚明了、寄義精確，避免正文的多義性，毛病的正文不只有益反而無害。
3、根本正文（必需加）
(a) 類（接口）的正文
(b) 結構函數的正文
(c) 辦法的正文
(d) 全局變量的正文
(e) 字段/屬性的注
備注：簡略的代碼做簡略正文，正文內容不年夜於10個字便可，別的，耐久化對象或
VO對象的getter、setter辦法不需加正文。詳細的正文格局請參考上面舉例。
4、特別必加正文（必需加）
(a) 典范算法必需有正文。
(b) 在代碼不了了處必需有正文。
(c) 在代碼修正處加上修正標識的正文。
(d) 在輪回和邏輯分支構成的代碼中加正文。
(e) 為別人供給的接口必需加具體正文。
備注：此類正文格局暫無舉例。詳細的正文格局自行界說，請求正文內容精確簡練。
5、正文格局：
1）、單行(single-line)正文：“//……”
2）、塊(block)正文：“/*……*/”
3）、文檔正文：“/**……*/”
4）、javadoc正文標簽語法
@author 對類的解釋 標明開辟該類模塊的作者
@version 對類的解釋 標明該類模塊的版本
@see 對類、屬性、辦法的解釋 參考轉向，也就是相干主題
@param 對辦法的解釋 對辦法中某參數的解釋
@return 對辦法的解釋 對辦法前往值的解釋
@exception 對辦法的解釋 對辦法能夠拋出的異常停止解釋
6、例子：
/**
樹立一個用於操作數組的對象類，個中包括這罕見的對數組的操作的函數:最值。
@author 張三
@version v.
*/
public class ArrayTool{
/**
獲得整形數組的最年夜值
@param arr 吸收一個元素為int類型的數組
@return 該數組的最年夜的元素值
*/
public int getMax(int arr){
int Max = ;
return Max;
}
}
輸出敕令以下圖：
然後在以下的目次下檢查，最初點擊 index.html：
以上內容給年夜家分享了Java代碼正文標准，願望對年夜家有所贊助。
