如何编写一个帮助文档
- 写一个工具类
- 对这个类加入文档注释
/**
*@author 作者
*@version 版本
*。。。
*@param 参数 参数说明
*@return 返回值说明
- 用javadoc工具来解析文档注释
- 解析一般的格式 javadoc -d 目录（如果不存在目录，系统会帮你自动创建，可以用路径指定）-author -version 要解析的类
解析帮助文档产生的错误总结
- 问题提示：找不到可以文档化的公共或受保护的类
问题：权限不够
解决方法：将要解析的类定义为public
- 问题提示：警告：@param未说明
问题：参数忘记加参数说明
解决方法：给@param参数添加参数说明 例如：@param player 游戏boy
相关文章：
-
2021-12-15
-
2022-12-23
-
2022-01-04
-
2021-07-31
-
2021-07-03
-
2021-12-05
-
2021-09-25
-
2021-09-25
猜你喜欢
-
2021-12-06
-
2021-08-04
-
2021-09-02
-
2021-12-15
-
2021-11-08
-
2022-01-18
相关资源
-
下载
2021-07-01
-
下载
2022-11-30
-
下载
2023-01-31
-
下载
2023-04-08