什么样的注释江湖才是我家是什么歌好注释

来源：蜘蛛抓取(WebSpider) 时间：2016-12-16 20:43 标签： 什么情况才是早泄
中国领先的IT技术网站
51CTO旗下网站
Java中注释的使用是有原则的
Java同样提供跨越多行的注释类型。这种类型的注释以紧跟着一个星号的正斜杠开始，并以紧跟着一个正斜杠的星号结束。这种类型注释的开始和结束分界符可以在同一行里也可以在不同的行上。例如：
作者：来源：ImportNew| 14:18
Java提供了3种类型的注释
多行注释(C风格)
Java同样提供跨越多行的注释类型。这种类型的注释以紧跟着一个星号的正斜杠开始，并以紧跟着一个正斜杠的星号结束。这种类型注释的开始和结束分界符可以在同一行里也可以在不同的行上。例如：
注意：C风格的注释不可以嵌套使用。比如下面的用法：
&blah&blah&blah&*/&
上面的用法会造成语法错误，因为Java编译器只把第一个 */ 当做注释来处理。(编译器认为注释在第一个&*/&就结束了)。
你可以在多行注释里嵌入单行注释：
以及在单行注释里使用多行注释：
文档注释是一种与多行注释很类似的特殊注释，它可以用来为你的源代码产生外部文档。这种注释以紧跟着两个星号的正斜杠开始，并以紧跟着一个正斜杠的星号结束。例如：
这里有一些关于文档注释的重要事情要注意：
javadoc文档生成器会把文档注释里的所有文本都添加到一个HTML段落里。这意味着，在文档注释里的任意文本都会被格式化为一个段落;空格和换行符会被忽略。如果你想要特殊的格式，你必须要在文档注释里使用HTML标签。
如果文档注释以超过两个的星号开始，那么javadoc就认为这些星号是用来在源码里创建一个&框&框住注释的，并忽略多余的星号。例如：
该注释仅保留&This is the start of a method&文本。
javadoc会忽略文档注释里处于行首的星号。例如：
该注释仅保留&This is a doc comment on multiple lines that I want to stand out in source code, looking &neat&&文本。
常见的用法如下：
该用法是为了突出注释。要注意的是，这属于文档注释(即使这不是你所想的那样)，并会在产生的文档里出现注释的内容。
什么时候使用文档注释
你(至少)应该在任意的公有类、接口、方法和源码里的类或实例变量前面使用文档注释。这样可以让javadoc针对代码产生简单的文档，它列出了公共实体 和每个实体的简要说明。你同样可以在非公共方法前面使用文档注释，不过需要使用一个javadoc选项来它们产生文档。相比于公有实体，在非公有实体上使 用文档注释显得没那么重要(它的接口不会暴露出来&&)。但如果你要注释代码，你同样可以使用文档注释。
什么时候使用单行注释
任意时候都可以!
关于注释，我有一个简单的建议，在你想写常规注释(不是用来描述类、接口、方法或者变量的文档注释)的时候可以使用单行注释。
为什么?因为你可以轻易地使用多行注释去&注释掉&你的代码段(&注释掉代码&意味着把一段代码的词法状态变为一段注释，让编译器忽略这段代码)。举个例子：
x&=&1;&&y&=&2;&&f(x,&y);&&
要把上面三行代码注释掉，你可能需要在每一行的前面使用单行注释：
或者在还没有加注释的地方加上多行注释：
或者分解或删除已存在的注释的&结束注释&分解符：
这些用法都糟糕透了。如果原始代码使用下面的注释，那么事情就好办多了：
如此一来，只需使用多行注释把代码围起来你就可以轻松把它注释掉：
在你需要使用注释的时候尽量使用单行注释。
什么时候使用多行注释
阅读了上面的内容后，这个问题变得很明显了。只使用多行注释来注释代码段，不要用以其他目的。【编辑推荐】【责任编辑： TEL：（010）】
大家都在看猜你喜欢
原创原创外电头条外电
24H热文一周话题本月最赞
讲师：1人学习过
讲师：24人学习过
讲师：0人学习过
精选博文论坛热帖下载排行
本书以BI解决方案的体系结构为中心，以SQL Server 2005为载体，将着眼点放在数据挖掘和商业智能上，详细讲解了数据报表、数据分析和数据挖...
订阅51CTO邮刊您所在的位置： &
你看到过的最好的代码注释是什么样的？
你看到过的最好的代码注释是什么样的？
外刊IT评论
外刊IT评论
编写代码良好的习惯就是写清楚注释，方便自己查阅也方便后来者熟悉代码，然而很多人留下的代码注释却让你啼笑皆非
下面是stackoverflow网站上网友针对?这个问题给出的回答的前10条：
//&亲爱的维护者： &//&如果你尝试了对这段程序进行&优化&， &//&并认识到这种企图是大错特错，请增加 &//&下面这个计数器的个数，用来对后来人进行警告： &//&浪费在这里的总时间&=&39h&
/**&*&致终于来到这里的勇敢的人： &&&&&你是被上帝选中的人，英勇的、不辞劳苦的、不眠不修的来修改 &我们这最棘手的代码的编程骑士。你，我们的救世主，人中之龙， &我要对你说：永远不要放弃，永远不要对自己失望，永远不要逃走，辜负了自己。 &永远不要哭啼，永远不要说再见。永远不要说谎来伤害自己。&*/&
Exception&up&=&new&Exception(&Something&is&really&wrong.&);&throw&&&
//&一些修改1&-&&增加临时的跟踪登录界面 &//&一些修改2&-&&我临时的犯傻&
#define&TRUE&FALSE&//逗一逗调试程序的傻瓜们&
if&(/*you*/&$_GET['action'])&{&//celebrate(恭喜)&
//&如果这段代码好用，那它是Paul&DiLascia写的。 &//如果不好用，我不知道是谁写的。&
//写这段代码的时候，只有上帝和我知道它是干嘛的 &//现在，只有上帝知道&
//&晕了，以后再修改&
//&神奇。勿动。&
你有没有更绝的?
原文：http://www.aqee.net/10-best-code-comments/
【编辑推荐】
【责任编辑： TEL：（010）】
关于的更多文章
不是每一个程序员都能够成为一个架构师――这是开发界广为流传的
网友评论TOP5
/art/962.htm
jstack--如果java程序崩溃生成core文件，jstack工具可
Play Framework是一个Rails风格full-stack（全栈的）J
所谓socket通常也称作"套接字"，用于描述IP地址和端口
本书专门根据SUN官方的SCSA for Solaris 9&10考试大纲撰写而成，全面覆盖了SCSA for Solaris 9/10的认证考点，除此之外本书还有
51CTO旗下网站

我要回帖

更多关于 什么情况才是早泄 的文章

 

随机推荐