代碼規(guī)范筆記-資料下載頁
2025-08-04 13:03本頁面
【正文】 va代碼尾端注釋的一個(gè)例子：[java]view plaincopy1. if(a==2){2. returnTRUE。/*specialcase*/3. }else{4. returnisprime(a)。/*worksonlyforodda*/5. }1行末注釋注釋分隔符“//”開頭的是不斷換行的注釋。它可以用來注釋掉整行或一行中的一部分。它一般不用于連續(xù)多行的文本注釋，但可以被用來注釋掉連續(xù)多行的代碼段。下面是所有三種風(fēng)格的例子：[java]view plaincopy1. if(foo1){2. //Doadoubleflip.3. ...4. }5. else6. returnfalse。//Explainwhyhere.7. 8. //if(bar1){9. //10. ////Doatripleflip.11. //...12. //}13. //else14. //returnfalse。1文檔注釋若想了解更多詳情，參見“How to Write Doc Comments for Javadoc”，其中包含了文檔注釋標(biāo)記的信息（@return,@param,@see）：關(guān)于文檔注釋和javadoc的更多信息，參見javadoc主頁：文檔注釋描述Java的類、接口、構(gòu)造器、方法和字段。每個(gè)文檔注釋都置于注釋分隔符/**...*/中，每個(gè)API對應(yīng)一個(gè)注釋。這個(gè)注釋應(yīng)該只出現(xiàn)在聲明之前：[java]view plaincopy1. /**2. *TheExampleclassprovides...3. */4. classExample{...注意類和接口是不縮進(jìn)的，而它的成員是縮進(jìn)的。類和接口的文檔注釋的第一行（/**）是不縮進(jìn)的，其后的文檔注釋行的都各有一個(gè)空格的縮進(jìn)（使星號(hào)垂直對齊）。成員，包括構(gòu)造方法，其文檔注釋的第一行是4個(gè)空格的縮進(jìn)，其后是縮進(jìn)5個(gè)空格。如果你需要給出有關(guān)類、接口、變量或方法的信息，而這些信息又不適合出現(xiàn)在文檔中，可以在緊跟在聲明之后使用塊注釋或單行注釋。例如一個(gè)類實(shí)現(xiàn)的細(xì)節(jié)，就應(yīng)該在緊跟在類聲明之后的塊注釋中，而不是在這個(gè)類的文檔注釋中。文檔注釋不應(yīng)該被放在方法或構(gòu)造器的定義塊中，因?yàn)镴ava會(huì)將文檔注釋與其后面的第一個(gè)聲明進(jìn)行關(guān)
環(huán)評公示相關(guān)推薦
鄂ICP備17016276號(hào)-1