java中說明書/開發文檔如何編寫?


由於在java開發時我們得到的或者給別人的文件一般都是class文件,不會給出源文件,故編寫一個簡潔易懂的說明書是必須的。

 

     ps: @param int[] arr 會有警告,可以刪掉 int []。

       用工具解析文檔注釋:javadoc工具

          javadoc -d 目錄 -d -author  -version ArrayTool.java

       有時會提示出錯:找不到可以文檔化的公共或受保護的類-->在class前加一個public即可。


免責聲明!

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



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