Java的三种注释形式包括单行注释、多行注释和文档注释。
单行注释:
//
可以用于对单行代码的简单解释,也可以用于快速注释掉某行代码,十分简洁明了。
多行注释
/* … */
用于较长的注释,通常用于解释代码块,代码的逻辑功能,或者代码的变更,或者用于吐槽,或者用于上一代、这一代、和下一代维护工程师之间的沟通与交流。
需要注意的是使用多行注释时要避免在多行注释内部嵌套多行注释,不然很容易出现bug。
文档注释
/**… */
提供非常详细的API说明,通常用于大项目开发中的功能解释。
文档注释中包含`@param`、`@return`、`@throws`等标签来详细说明方法参数、返回值和可能抛出的各类程序异常。
注意:
单行注释和多行注释在编译时不参与程序执行。
文档注释在编译时则会被Javadoc工具提取出来,生成可用于API文档的文本。
原创文章,作者:guozi,如若转载,请注明出处:https://www.sudun.com/ask/81031.html