注释的重要性

  对于一份规范的程序源代码而言,注释是非常重要的一部分,且应该占到源代码的三分之一以上。

  Java的注释主要有三种类型:单行注释、多行注释、文档注释。

  我们这里主要说明一下文档注释。文档注释主要是用来生成API文档的,如果一个系统在编写源代码的时候添加了合适的文档注释,通过JDK提供的Javadoc工具可以直接将源代码里的文档注释提取成一份系统的API文档。

  最后说一下我们为什么要添加注释:

  1.永远不要过度相信自己的理解力。

  2.可读性第一,效率第二。

  3.代码及文档。

  相信在当前普遍团队开发合作的环境下,注释将会变得越来越重要!

posted @   pengguoping  阅读(168)  评论(0编辑  收藏  举报
相关博文:
阅读排行:
· winform 绘制太阳,地球,月球 运作规律
· AI与.NET技术实操系列(五):向量存储与相似性搜索在 .NET 中的实现
· 超详细:普通电脑也行Windows部署deepseek R1训练数据并当服务器共享给他人
· 【硬核科普】Trae如何「偷看」你的代码?零基础破解AI编程运行原理
· 上周热点回顾(3.3-3.9)
点击右上角即可分享
微信分享提示