Java入门代码注释与编码规范(羊驼)
一、代碼注釋
1.單行注釋
“//”為單行注釋標(biāo)記,從符號“//”開始直到換行位置的所有內(nèi)容均做為注釋而被編輯器忽略
//注釋內(nèi)容2.多行注釋
“/**/”為多行注釋標(biāo)記,符號“/*”與“*/”之間的所有內(nèi)容均為注釋內(nèi)容,注釋中的內(nèi)容可換行
/* 注釋內(nèi)容 *//*注釋內(nèi)容*/提示:
在多行注釋中可以加嵌套單行注釋例:
?
但在多行注釋中不可以嵌套多行注釋,以下代碼為非法:
/*程序名稱:Hello World /*開發(fā)時間:2008-03-05作者:羊駝 */*/3.文檔注釋
“/** */”為文檔注釋標(biāo)記,符號“/**”與“*/”之間的內(nèi)容均為文檔注釋內(nèi)容
二、編碼規(guī)范
在學(xué)習(xí)開發(fā)的過程要養(yǎng)成良好的編碼習(xí)慣,因?yàn)橐?guī)范的代碼格式會給程序的開發(fā)與日后的維護(hù)提供很大的方便。在此編碼規(guī)則作了以下總結(jié)
1.每條語句要單獨(dú)占一行,一條命令要以分號結(jié)束
2.在聲明變量時,盡量使每個變量的聲明單獨(dú)占一行,即使是相同的數(shù)據(jù)類型也要將其放置在單獨(dú)一行上,這樣有助于添加注釋
3.在java代碼中,關(guān)鍵字與關(guān)鍵字之間如果有多個空格,這些空格均視為一個
4.為了方便日后的維護(hù),不要使用技術(shù)性很高、難懂、易混亂的判斷語句,由于程序的開發(fā)與維護(hù)不能是同一個人,所以應(yīng)盡量使用簡單技術(shù)完成程序需要的功能
5.對于關(guān)鍵的方法要多加注釋,這樣有助于讀者了解代碼結(jié)構(gòu)
總結(jié)
以上是生活随笔為你收集整理的Java入门代码注释与编码规范(羊驼)的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: [QUANTAXIS量化分析]羊驼策略1
- 下一篇: com.thoughtworks.xst