Java帮助文档的编写和生成

标签：player   auth   返回值   问题：   提示   ret   定义   @param   作者   

/**

*对这个类或方法加入文档注释
*@author 作者
*@version 版本
*。。。
*@param 参数 参数说明
*@return 返回值说明

解析帮助文档产生的错误总结：

• 问题提示：找不到可以文档化的公共或受保护的类

问题：权限不够

解决方法：将要解析的类定义为public

• 问题提示：警告：@param未说明

问题：参数忘记加参数说明

解决方法：给@param参数添加参数说明 例如：@param player 游戏boy

Java帮助文档的编写和生成

标签：player   auth   返回值   问题：   提示   ret   定义   @param   作者   

原文地址：https://www.cnblogs.com/jijijijibeibeibei/p/12040803.html