1.注释:Comment
分类:
单行注释://
多行注释:/* */
文档注释:/** */
作用:
①对所写的程序进行解释说明,增强可读性。方便自己,方便别人
②调试所写的代码
特点:
①单行注释和多行注释,注释了的内容不参与编译。
换句话说,编译以后生成的。class结尾的字节码文件中不包含注释掉的信息
②注释内容可以被JDK提供的工具 javadoc所解析,生成一套以网页文件形式体现的该程序的说明文档。
③多行注释不可以嵌套使用
2.Java API 文档:
API:application programming interface。习惯上:将语言提供的类库,都称为api.
API文档:针对于提供的类库如何使用,给的一种说明书。类似于《新华字典》
3.良好的编程风格
Java注释与API文档
最新推荐文章于 2022-11-20 15:09:51 发布
本文探讨了Java中的三种注释类型:单行//、多行/*...*/和文档注释/**...**,它们的作用、特点,以及API文档在编程中的重要性。通过良好编程风格,理解如何利用注释增强代码可维护性和文档生成。
摘要由CSDN通过智能技术生成