java中说明书/开发文档如何编写?

由于在java开发时我们得到的或者给别人的文件一般都是class文件,不会给出源文件,故编写一个简洁易懂的说明书是必须的。

 

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

       用工具解析文档注释:javadoc工具

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

       有时会提示出错:找不到可以文档化的公共或受保护的类-->在class前加一个public即可。

posted @ 2016-07-06 16:59  alsdf  阅读(3605)  评论(0)    收藏  举报