程序的注释是源代码的重要组成部分,对于一个规范的程序代码而言,注释应该占代码的三分之一。
java的注释类型:单行注释 多行注释 文档注释。
java的文档注释功能非常强大,java源代码添加合适的文档注释,可以通过javadoc命令生成java的API文档。
API文档就是对各个类的方法和字段进行说明以及使用规定。
文档注释格式:
文档注释以斜杠后面紧跟2个星号(/**)开始,以1个星号紧跟一个斜线结尾,中间部分就是注释文档的内容,会被提取到API文档中。
程序的注释是源代码的重要组成部分,对于一个规范的程序代码而言,注释应该占代码的三分之一。
java的注释类型:单行注释 多行注释 文档注释。
java的文档注释功能非常强大,java源代码添加合适的文档注释,可以通过javadoc命令生成java的API文档。
API文档就是对各个类的方法和字段进行说明以及使用规定。
文档注释格式:
文档注释以斜杠后面紧跟2个星号(/**)开始,以1个星号紧跟一个斜线结尾,中间部分就是注释文档的内容,会被提取到API文档中。
转载于:https://my.oschina.net/u/1160343/blog/270803