当前位置: 首页 > 科技观察

Java中注释的使用原则

时间:2023-03-17 10:02:21 科技观察

Java提供了3种注释例如://thisisasingle-linecommentx=1;//asingle-linecommentaftercode多行注释(C风格)Java也提供了跨越多行的注释类型。这种类型的注释以正斜杠后跟星号开头,并以星号后跟正斜杠结尾。此类注释的开始和结束分隔符可以在同一行或不同行。例如:/*Thisisac-stylecomment*//*Thisisalsoac-stylecomment,spanningmultiplelines*/注意:C风格的注释不能嵌套。例如下面的用法:/*Acommentlookslike/*Thisisacomment*/blahblahblah*/上面的用法会导致语法错误,因为Java编译器只把第一个*/当作注释。(编译器认为注释在第一个“*/”处结束)。您可以在多行注释中嵌入单行注释:/*Thisisasingle-linecomment://asingle-linecomment*/并在单行注释中使用多行注释:///*thisis//amulti-line//comment*/DocumentationComments文档注释是一种特殊的注释,很像多行注释,可用于为您的源代码生成外部文档。此注释以一个正斜杠后跟两个星号开头,以一个星号后跟一个正斜杠结尾。例如:/**Thisisdocumentationcomment*//**Thisisalsoadocumentationcomment*/以下是关于文档注释的一些重要注意事项:javadoc文档生成器会将文档注释中的所有文本添加到HTML段落中。这意味着文档注释中的任何文本都将被格式化为段落;空格和换行符将被忽略。如果需要特殊格式,则必须在文档注释中使用HTML标记。如果文档注释以两个以上的星号开头,则javadoc假定这些星号用于在源代码中的注释周围创建一个“框”,并忽略额外的星号。例如:该注释仅保留“这是方法的开始”文本。javadoc忽略文档注释行开头的星号。例如:注释只保留文本“ThisisadoccommentonmultiplelinesthatIwanttostandoutinsourcecode,looking”。常用用法如下:这种用法是为了突出注释。注意这个是文档注释(即使它不是您认为的那样),并且会出现在生成的文档中。何时使用文档注释您应该(至少)在任何公共类、接口、方法和类之前使用文档注释,或者源代码中的实例变量。这允许javadoc为代码生成简单的文档,其中列出了常见的实体和每个实体的简要描述。你也可以在非公共方法前面使用文档注释,但你需要使用为它们生成文档的javadoc选项。在非公共实体上使用doc注释不如在公共实体上使用文档注释重要(其接口未公开......)。但是如果你想注释代码,你也可以使用文档注释.何时使用单行注释任何时候都可以!关于注释,我有一个简单的建议,当你想编写常规注释时使用单行注释(而不是用于描述类、接口、方法或变量的文档注释)。为什么?因为你可以很容易地使用多行注释来“注释掉”你的部分代码(“注释掉代码”就是把一段代码的词法状态变成注释,让编译器忽略它)。例如:x=1;/*setxto1*/y=2;/*setyto2*/f(x,y);/*callfwithxandy*/注释掉以上三行代码,可能需要添加使用a前面单行注释://x=1;/*setxto1*///y=2;/*setyto2*///f(x,y);/*callfwithxandy*/或者在没有的地方加上多行注释:/*x=1;*//*setxto1*//*y=2;*//*setyto2*//*f(x,y);*//*callfwithxandy*/或分解或者删除已有注释的“结束注释”分隔符:/*x=1;/*setxto1*/y=2;/*setyto2*/f(x,y);/*callfwithxandy*/*/这些用法是可怕。如果原代码使用下面的注释就容易多了:x=1;//setxto1y=2;//setyto2f(x,y);//callfwithxandy这样,只用多行注释把代码放上去包围起来就可以方便的注释掉:/*x=1;//setxto1y=2;//setyto2f(x,y);//callfwithxandy*/需要使用注释时,尽量使用单行注释.当使用多行注释时,阅读以上内容后这个问题就很明显了。多行注释仅用于注释代码段,不得用于其他目的。