Java的注释
来源:互联网 发布:php跳转id代码 编辑:程序博客网 时间:2024/06/03 06:59
编写程序时总需要为程序添加一些注释,用以说明某段代码的作用,或者说明某个类的用途、某个方法的功能,以及该方法的参数和返回值的数据类型及意义等。
为什么要添加注释:
(1)永远不要过于相信自己的理解力!一段时间过后,你很难再重进进入当初编写程序时的思维。
(2)可读性第一,效率第二!越来越多的人加入了软件队伍,并引用了工程化的方式来管理软件开发。这个时候,软件开发变成了团队的协同作战,因此一个人写的代码要便于其他人能够快速理解。
(3)代码即文档,代码是程序文档的重要组成部分,程序文档规范要求代码书写规范。
注释:单行注释 // 注释内容 多行注释 /* 注释内容 */ 文档注释 /** 注释内容 */ Java 提供的Javadoc工具可以将文档注释抽离出来生成一份系统的API文档,方便开发者查看。注意:Javadoc默认只能提取出public和protected修饰的变量或方法。如果希望提取出private修饰的方法或变量,则需要在Javadoc增加-private选项。
0 0
- java的注释
- Java注释的写法
- Java的注释规范
- JAVA的注释规范
- Java注释的使用
- java 注释的格式
- Java的注释规范
- Java 的注释用法
- JAVA源代码的注释
- java的注释快捷键
- java 注释的使用
- Java的注释说明
- java的文档注释
- Java的注释说明
- Java的注释说明
- Java的注释说明
- Java的注释说明
- Java的注释
- 包含min函数的栈
- 算法导论 练习题 11.1-3
- MIME参考列表
- Bootstrap里的文件分别代表什么意思及其引用方法
- opencv---小知识记录
- Java的注释
- make命令和makefile文件
- 从mysql取数据时出现Before start of result set
- 欢迎使用CSDN-markdown编辑器
- HTML5之废弃和更新的元素与属性
- java中讲讲FileWriter的用法,举例?
- sdut 3258 (第六届山东省ACM省赛H题)
- 匿名内部类
- .net源码调试 http://referencesource.microsoft.com/