Java中生成幫助文檔

如何在Java中使用註釋

在編寫程序時，常常須要添加一些註釋，用以描述某段代碼的做用。

通常來講，對於一份規範的程序源代碼而言，註釋應該佔到源代碼的 1/3 以上。所以，註釋是程序源代碼的重要組成部分，必定要加以重視哦！

Java 中註釋有三種類型：單行註釋、多行註釋、文檔註釋

運行結果： Hello Imooc!

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

咱們能夠經過 javadoc 命令從文檔註釋中提取內容，生成程序的 API 幫助文檔。

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

PS：使用文檔註釋時還能夠使用 javadoc 標記，生成更詳細的文檔信息：

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

       @version 標明該類模塊的版本

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

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

       @return 對方法返回值的說明

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