博客
关于我
关于java代码中的注释问题。(类中方法的注释,我们一般都要写上这个方法的文档(doc),方法的参数也要有它的文档)
阅读量:753 次
发布时间:2019-03-23

本文共 633 字,大约阅读时间需要 2 分钟。

以下是优化后的内容:

开发人员在编写Java代码时,往往需要为代码添加注释,以便更好地理解代码功能、维护软件系统。特别是在处理接口或类的方法定义时,使用Javadoc注释能为代码增添文档信息。此处必须包含文档信息,否则可能会引发checkStyle或者其他代码检验工具的警告提示。

在编写Javadoc注释时,建议遵循以下准则:

  • 注释格式规范:确保注释的语法语法符合Javadoc的标准格式,同时保持文档内容的准确性。例如,使用@param标识参数说明,@return标识返回值说明。

  • 参数说明的规范

    • @param userId <span>用户ID</span>。在注释后面使用空格,这样可以让checkStyle工具正确解析你的注释。内容中建议使用英文命名规则,并用中文进行参数描述。
  • 返回值说明的规范

    • @return&nbsp; return&nbsp; <span>返回用户列表</span>。同样,确保在注释中使用空格,并使用
      表示空白字符。推荐使用简单明了的术语描述返回值。
  • 注释内容的准确性

    • 请确保文档内容(即<div>内的内容)不会缺失。如果缺失相关内容,可能会影响代码质量检查,导致问题复杂度增加。

注意事项

  • @param标签后面必须使用半角空格,而不是全角空格,否则可能导致checkStyle无法正确解析你的注释。
  • 避免使用复杂的格式和过多的标签,保持注释内容的简洁本原。
  • 如果需要使用颜色标识关键词,可以使用等标签,而不是标签。

转载地址:http://gswzk.baihongyu.com/

你可能感兴趣的文章
MySQL – 导出数据成csv
查看>>
MySQL —— 在CentOS9下安装MySQL
查看>>
MySQL —— 视图
查看>>
mysql 不区分大小写
查看>>
mysql 两列互转
查看>>
MySQL 中开启二进制日志(Binlog)
查看>>
MySQL 中文问题
查看>>
MySQL 中日志的面试题总结
查看>>
mysql 中的all,5分钟了解MySQL5.7中union all用法的黑科技
查看>>
MySQL 中的外键检查设置:SET FOREIGN_KEY_CHECKS = 1
查看>>
Mysql 中的日期时间字符串查询
查看>>
mysql 中索引的问题
查看>>
MySQL 中锁的面试题总结
查看>>
MySQL 中随机抽样:order by rand limit 的替代方案
查看>>
MySQL 为什么需要两阶段提交?
查看>>
mysql 为某个字段的值加前缀、去掉前缀
查看>>
mysql 主从
查看>>
mysql 主从 lock_mysql 主从同步权限mysql 行锁的实现
查看>>
mysql 主从互备份_mysql互为主从实战设置详解及自动化备份(Centos7.2)
查看>>
mysql 主从关系切换
查看>>