发布时间:2022-03-12 14:22:34来源:转载
Java中注释有两种类型:程序注释和文档注释。程序注释是对程序某个部分的具体实现的注释;文档注释是对程序的描述性注释,主要是为那些不需要知道程序的具体实现的开发者提供的。
Java提供有两种类型的注释:程序注释和文档注释。
程序注释是由分隔符/*···*/和//隔开的部分,这些注释与C++中的注释相同。文档注释是Java所特有的,由分隔符/**···*/隔开,文档注释可以用javadoc工具提取出来,形成HTML文件。
程序注释是对程序某个部分的具体实现的注释;文档注释是对程序的描述性注释,主要是为那些不需要知道程序的具体实现的开发者提供的。注释中可以描述一些精妙的算法和一些不容易理解的设计思想。
但应该避免那些在程序代码中很清楚地表达出来的信息。尽可能地避免过时的信息,错误的注释比没有注释更有害,经常性的注释有时也反映出代码质量的低下。
程序注释有四种类型:块注释、单行注释、跟随注释和行尾注释。
(1)块注释:主要用于描述文件、方法、数据结构和算法。它通常用在文件或方法定义之前,也可以用在方法定义里面,此时它的缩进必须与它所描述的代码相同。
块注释应该以空行开始,以便于区分代码的各个部分。
2、单行注释:一个相对较短的注释可以放在单行上,但必须与它后面的代码有相同的缩进。如果注释不适合放在一行,那么它必须用块注释的格式来写。
3、跟随注释:一个非常短的注释可以和它所描述的代码放在同一行,但要确保代码和注释之间有足够的间距。如果在同一个代码块中有多个这样的注释,它们应该是对齐的。
4、行尾注释。行尾注释不能用于多行文本注释,但可以对多行代码进行注释。注释标记"//"可以注释一行或以"//"开始的部分,直到该行的结束。
文档注释描述了Java类、接口、构造函数等。每个类、接口或成员在声明它的地方之前只有一个文档注释。较外层的类或接口的文档注释是不缩进的,但其成员的文档注释的缩进格式与成员的声明相同。
一级建造师 二级建造师 消防工程师 消防设施操作员 BIM 造价工程师 环评师 监理工程师 咨询工程师 安全工程师 建筑九大员 公路水运检测 通信工程 智慧消防工程师 装配工程师 一级注册建筑师 二级注册建筑师 注册电气工程师 智慧建造工程师 房地产估价师 EPC工程总承包 碳排放管理师 雅思 托福 GRE 托业 SAT GMAT A-Level ACT AP课程 OSSD 多邻国英语 考研英语 英语四六级 商务英语 青少儿英语 少儿英语 剑桥英语 职场英语 个人提升英语 旅游英语 英语口语 出国英语 初高中英语 学生英语 成人英语 公共英语 词库 经济师 初级会计师 中级会计师 注册会计师 基金从业 证券从业 薪税师 银行从业 CMA ACCA 会计实训 税务师 CFA 企业合规师 审计师 FRM 高级会计师 税务师 期货从业 CQF 真账实操技能 葡萄牙语 日语 德语 法语 韩语 西班牙 意大利 高考小语种 粤语 泰语 俄语 阿拉伯语 电商视觉设计 影视后期 剪辑包装 游戏设计 游戏程序 UI设计 室内设计 UXD全链路 平面设计 CAD设计制图 商业空间设计