博客
关于我
关于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/

你可能感兴趣的文章
MTD技术介绍
查看>>
MySQL
查看>>
MySQL
查看>>
mysql
查看>>
MTK Android 如何获取系统权限
查看>>
MySQL - 4种基本索引、聚簇索引和非聚索引、索引失效情况、SQL 优化
查看>>
MySQL - ERROR 1406
查看>>
mysql - 视图
查看>>
MySQL - 解读MySQL事务与锁机制
查看>>
MTTR、MTBF、MTTF的大白话理解
查看>>
mt_rand
查看>>
mysql -存储过程
查看>>
mysql /*! 50100 ... */ 条件编译
查看>>
mudbox卸载/完美解决安装失败/如何彻底卸载清除干净mudbox各种残留注册表和文件的方法...
查看>>
mysql 1264_关于mysql 出现 1264 Out of range value for column 错误的解决办法
查看>>
mysql 1593_Linux高可用(HA)之MySQL主从复制中出现1593错误码的低级错误
查看>>
mysql 5.6 修改端口_mysql5.6.24怎么修改端口号
查看>>
MySQL 8.0 恢复孤立文件每表ibd文件
查看>>
MySQL 8.0开始Group by不再排序
查看>>
mysql ansi nulls_SET ANSI_NULLS ON SET QUOTED_IDENTIFIER ON 什么意思
查看>>