Java中使用注釋


在編寫程序時,經常需要添加一些注釋,用以描述某段代碼的作用。

一般來說,對於一份規范的程序源代碼而言,注釋應該占到源代碼的 1/3 以上。因此,注釋是程序源代碼的重要組成部分,一定要加以重視哦!

Java 中注釋有三種類型:單行注釋、多行注釋、文檔注釋

運行結果: Hello Imooc!

看:被注釋的代碼塊在程序運行時是不會被執行的~~

我們可以通過 javadoc 命令從文檔注釋中提取內容,生成程序的 API 幫助文檔。

打開首頁,查看下生成的 API 文檔

PS:使用文檔注釋時還可以使用 javadoc 標記,生成更詳細的文檔信息:

       @author 標明開發該類模塊的作者

       @version 標明該類模塊的版本

       @see 參考轉向,也就是相關主題

       @param 對方法中某參數的說明

       @return 對方法返回值的說明

       @exception 對方法可能拋出的異常進行說明


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM