java_代码注释风格

<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><template autoinsert="true" context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
 * ${tags}
 */</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="Comment for overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/* (non-Javadoc)
 * ${see_to_overridden}
 */</template><template autoinsert="false" context="typecomment_context" deleted="false" description="Comment for created types" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**@declare:  &lt;br&gt;
 * @author: cphmvp
 * @version: 1.0
 * @date: ${date}${time}
 */</template><template autoinsert="true" context="fieldcomment_context" deleted="false" description="Comment for fields" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**
 *
 */</template><template autoinsert="true" context="settercomment_context" deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**
 * @param ${param} the ${bare_field_name} to set
 */</template><template autoinsert="false" context="filecomment_context" deleted="false" description="Comment for created Java files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**
 * 类说明:  &lt;br&gt;
 * ${user} ${date}创建&lt;br&gt;
 *
 * @author cphmvp
 */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="Comment for delegate methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**
 * ${tags}
 * ${see_to_target}
 */</template><template autoinsert="false" context="methodcomment_context" deleted="false" description="Comment for non-overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/** @declare
 * ${tags}
 * @author cphmvp
 */    </template><template autoinsert="true" context="gettercomment_context" deleted="false" description="Comment for getter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
 * @return the ${bare_field_name}
 */</template></templates>

保存为  codetemplates.xml

windows prefences ->java ->code templates  Comments   import

时间: 2024-10-11 18:58:42

java_代码注释风格的相关文章

vs2010代码注释自动生成api文档

最近做了一些接口,提供其他人调用,要写个api文档,可是我想代码注释已经写了说明,能不能直接把代码注释生成api?于是找到以下方法 环境:vs2010 先下载安装Sandcastle 和Sandcastle Help File Builder 下载地址 http://sandcastle.codeplex.com/ http://shfb.codeplex.com/ 其中Sandcastle Help File Builder安装较复杂,安装红框内的即可 安装完成后,然后让要使用的项目输出xml

那些令人喷饭的代码注释:仅以此代码献给...

程序源代码中的注释经常是一个卧虎藏龙的地方,有人就很喜欢写幽默搞笑的注释内容.解释代码含义的同时,也带给人轻松神经的机会,确实是很有意思的风格 ,来看看这一辑国外某公司产品中的注释. 注意:看的时候严禁喝水或进食. 1 .亲爱的代码维护人员: 当您尝试优化这段代码但发现这是一个极端错误的决定的时候,请修改下面的计时器,以便警示后人. 总计浪费在这段代码的时间 = 16小时 2 .真的很有问题 3 .谨以此代码献给我的妻子达琳,感谢她一直支持我,还有我三个孩子和一只狗. 4 .神奇代码,请勿改动

Java 程序代码书写风格及一些简单的注意事项 (

1. 风格务必保持一贯性(Consistent) 一位同胞顶着我的鼻子问,为什么我们的Java代码缩进格式非得是这样,而不能是他那样,他就是喜欢他自己的这一种,因此他写的代码总是用他自己习惯的风格.结果在Code Review里被大家毙掉,责令修改.因此他是大大地不服.就是风格一贯性问题.其实他的风格,本来也没有什么问题,但在项目里,和其他程序员的程序的风 格,显得扃异,那就存在问题了.比如这个缩进,又比如变量命名方法,不同的类,不同的Methods里,各自不同,这程序就很难看了.所以一旦你选择

Java代码注释

通过代码注释,可提高程序的可读性.注释中包含了程序的信息,可以帮助从程序员更好的阅读和理解程序.Java源文件的任意位置都可以添加注释语句.注释的文字Java编译器不进行编译,所有代码中的注释文字对程序不产生影响.Java提供了三种注释方法,分别为单行注释,多行注释,文档注释. 1 单行注释 "//"为单行注释的符号,从符号"//"开始到换行位置均为注释而被Java编译器忽略.语法如下:       //注释内容 例如:以下代码为声明int型变量添加注释. int

自动化测试代码注释规范

原文链接:http://www.cnblogs.com/zishi/p/6857606.html 一.页头加入代码说明块,格式如下: /************************** *@file *@author XXXXXX *@remarks Modified by XXXXXX *@version *@Modified at 2017/12/6 *@Copyright ? 2012 All Rights Reserved. ***************************/

代码注释率统计的Python及Java实现

这是一个简单的Java代码注释率统计工具,能够查找某个指定目录下的每个.java文件注释率及该路径下所有.java文件的总注释率. 注释率=注释代码行数/代码总行数,其中代码总行数包括注释行和空格行. 在Java中有行注释(//).块注释(/*--*/)和Javadoc注释(/**--*/)三种风格,通过逐行读取文件,并判断是否包换这些字符就可以实现判断一行代码是否包含注释.为了增加准确率,引号内的字符串不计入统计范围. Python的实现如下: #coding:utf8 #@author ly

《重构:改善既有代码的设计》——关于代码注释的唠叨

这几天在看<重构:改善既有代码的设计>英文评注版这本书,以前简单看过这本书,但并不是看的特别深入.经过了一段时间的"磨练",现在回来重新看这本书,又很多想法. 首先,这本书是一本好书,我感觉是软件工程师必看的一本书,而且如果有大量的编码经验看这本书会收获很大.这本书主要内容是代码重构. 在书中第3章中有这样一段话是用来描述代码注释的: A good time to use a comment is when you don't know what to do. In add

浅谈Verilog HDL代码编写风格

消失了好久,没有写文章,也没有做笔记,因为最近再赶一个比赛,时间很紧,昨天周六终于结束了,所以趁着周末这会儿有时间,写点东西,记录下来.首先我学习FPGA才一年多,我知道自己没有资格谈论一些比较深层次的问题,对于这个行业来说可能我才是一直脚踩在门外面.所以这篇文章是写给一些刚开始学习FPGA.Verilog HDL的同学,我看过一些大神写的代码,然后尽量模仿大神写法,经过好几个大神的影响和自己的习惯摸索,最终算是总结出了一套自己的代码书写风格,当然我的代码风格还是一直在进化中.现在将自己的一些经

从开源项目看python代码注释

最近看了不少代码,也写了不少代码,所以在看和写之间发现了很多的问题,真的是很多,至少从我的认识来看,有几个地方有很大的改进空间,这里不准备把所有的问题都列举出来,所以就先挑选一个比较明显得来和大家聊聊.回顾流行开源项目的成功,除了功能上的刚需之外,文档也是必不可少的一个环节,没有良好文档的开源项目几乎不可能说是流行的,因为很少人会因为你说了一句使用我的项目就可以怎么怎么样就傻不溜秋得用你的.从我以前开源的项目中大家可能会发现一个比较大的问题就是文档工作做得确实不咋地. 项目中的文档我认为可以分为