Java帮助文档的编写和生成
Posted jijijijibeibeibei
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Java帮助文档的编写和生成相关的知识，希望对你有一定的参考价值。
/**
*对这个类或方法加入文档注释
*@author 作者
*@version 版本
*。。。
*@param 参数 参数说明
*@return 返回值说明
解析帮助文档产生的错误总结：
- 问题提示：找不到可以文档化的公共或受保护的类
问题：权限不够
解决方法：将要解析的类定义为public
- 问题提示：警告：@param未说明
问题：参数忘记加参数说明
解决方法：给@param参数添加参数说明 例如：@param player 游戏boy
以上是关于Java帮助文档的编写和生成的主要内容，如果未能解决你的问题，请参考以下文章