注释的重要性

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

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

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

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

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

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

  3.代码及文档。

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

posted @ 2022-05-23 19:04  pengguoping  阅读(119)  评论(0编辑  收藏  举报