Java注釋的三種方式:單行、多行和文檔
通常我們需要在源代碼中添加文字用來對進行代碼解釋說明,但這些文字并不是 Java 代碼的語法,會
導致編譯出錯。這時我們可以使用注釋來完成這一事項!
在編譯時,編譯器會忽略注釋的存在,就好像注釋內容不存在一樣。所以注釋并不會導致編譯出錯,
同時注釋還方便編寫者和其他人閱讀源代碼,加強對代碼的理解。
Java中提供了三種注釋方式:
(1)單行注釋: // 注釋內容
快捷鍵:【注釋 ctrl+/?】?、 【 取消注釋 ctrl+/ 】

(2)多行注釋 /* 注釋內容 */
快捷鍵:【注釋 ctrl+shift+/?】?【取消注釋 ctrl+shift+\ 】

(3)文檔注釋 /** 注釋內容 */
文檔注釋和多行注釋的作用基本相同,唯一的區(qū)別時文檔注釋可以使用javadoc.exe命令生成API文
檔。
建議寫代碼的時候先寫思路,分析,步驟,然后再寫代碼。思路,分析,步驟使用注釋放在源代碼
中。

為什么要添加程序注釋?
(1)用于不要過于相信自己的理解能力!
(2)可讀性第一,效率第二,軟件開發(fā)需要團隊合作,一個人寫的代碼需要被整個團隊的其他人理解,
所以注釋是必要的。
(3)代碼即文檔,程序源代碼是程序文檔的重要組成部分。軟件里最重要的文檔:源代碼寫規(guī)范。
標簽: