首页 > 编程语言 > 详细

Java帮助文档的编写和生成

时间:2019-12-14 21:34:39      阅读:140      评论:0      收藏:0      [点我收藏+]

/**

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

 

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

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

问题:权限不够

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

 

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

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

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

 

 

 

Java帮助文档的编写和生成

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

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!