码迷,mamicode.com
首页 > 编程语言 > 详细

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

时间:2016-07-06 18:05:57      阅读:125      评论:0      收藏:0      [点我收藏+]

标签:

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

技术分享

 

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

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

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

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

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

标签:

原文地址:http://www.cnblogs.com/huangytao/p/5647452.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!