eclipse简单注释规范

设置注释模板的入口: Window->Preference->Java->Code Style->Code Template

Types
/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author [email protected]
* @date ${date} ${time}
*
* ${tags}
*/

Methods
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param ${tags} 设定文件
* @return ${return_type} 返回类型
* @throws
*/

时间: 2024-08-28 07:23:34

eclipse简单注释规范的相关文章

关于文档注释规范

关于文档注释规范 准备工作: 双击打开文件夹 用editplus或其他编辑器打开 修改配置文件中: 引入配置文件: Step1:将模板配置文件放在myeclipse的安装目录下 Step2:window ---> preference Step3:导入配置文件 使用: Step1: Step2:则会自动生成注释,按上面的要求写注释 关于编码规范 参考<华为编码规范>文档. 附录: <?xml version="1.0" encoding="UTF-8&

java注释规范

前言: 现在java的出产地sun公司并没有定义一个java注释规范,注释规范目前是每个公司自己有自己的一套规范,主要是为了团队之间的协作. 1.基本规则 1.注释应该使代码更加清晰易懂 2.注释要简洁明了,只要提供能够明确理解程序必要的信息就可以了.如果注释太复杂会影响程序整洁度和阅读感. 3.注释不仅描述程序作了什么,还要描述为什么这样做以及约束. 4.对于一般的getter和setter方法不用注释. 5.类.接口.构造函数.方法.全局变量必须添加注释.字段属性可以选择添加简单注释. 6.

java 注释规范 参照

1.注释形式统一 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释.如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范. 2.注释内容准确简洁 内容要简单.明了.含义准确,防止注释的多义性,错误的注释不但无益反而有害. 注释条件: 1.基本注释(必须加) (a) 类(接口)的注释 (b) 构造函数的注释 (c) 方法的注释 (d) 全局变量的注释 (e) 字段/属性的注释 备注:简单的代码做简单注释,注释内容不大于10个字即可,

java代码注释规范-----转载-----http://blog.csdn.net/shiyuezhong/article/details/8205281/

1 代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率.也是程序代码可维护性的重要环节之一.所以我们不是为写注释而写注释.下面说一下我们在诉求网二期开发中使用的代码注释规范,供大家参考下. 2 3 原则: 4 1.注释形式统一 5 6 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释.如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范. 7 8 2.注释内容准确简洁 9 10 内容要简单.明了.含

eclipse简单配置 eclipse中使用github Eclipse 快捷键

将eclipse压缩包解压到英文目录下 eclipse简单配置 设置字符集 Window--Preferences--General--Workspace--Text file Encoidng--Other--UTF-8 设置JDK路径 Window--Preferences--Java--Installed JREs 检查路径对应的是否为jdk,而不是jre.如果不是,要进行配置. 设置代码格式 Window--Preferences--Code Style--Formatter--edit

详细聊聊Javadoc注释规范

Javadoc 注释规范 1. 注释分类 2. Java文档和Javadoc 3. 文档注释的格式 3.1 文档和文档注释的格式化 3.2 文档注释的三部分 4. 使用Javadoc标记 4.1 @see 的使用 4.2 @author.@version 说明类 4.3 @param.@return 和 @exception 的使用 5. Javadoc命令 6. 注释范例 1.注释分类 对于Java注释共有三种分类: 1. // 注释单行 2. /* - */ 注释若干行 3. /* - /

Eclipse 修改注释的 date time 日期时间格式,即${date}变量格式

Eclipse 修改注释的 date time 日期时间格式,即${date}变量格式 找到eclipse安装目录下面的plugins目录,搜索 org.eclipse.text ,找到一个jar包, 例如我找到的jar包为:org.eclipse.text_3.5.300.v20130515-1451.jar 然后打开它,找到这个类: org.eclipse.jface.text.templates.GlobalTemplateVariables 我们重写这个类就行了.(可反编译,也可以找到源

Java注释规范整理

在软件开发的过程中总是强调注释的规范,但是没有一个具体的标准进行说明,通常都是在代码编写规范中简单的描述几句,不能作为一个代码注释检查的标准和依据,做什么都要有一个依据吗:),现在我特整理了一个<Java的注释规范>,内容来自网络.书籍和自己的实际积累. JAVA注释规范 版本/状态 作者 版本日期 1.0 ghc 2008-07-02 一.背景 1.当我们第一次接触某段代码,但又被要求在极短的时间内有效地分析这段代码,我们需要什么样的注释信息? 2.怎么样避免我们的注释冗长而且凌乱不堪呢? 

C/C++注释规范

C/C++注释规范 Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C.C++.Java.Objective-C和IDL语言,部分支持PHP.C#.鉴于Doxygen良好的注释风格,故基于Doxygen以形成自己的注释规范. 1.标注总述 //------------------------------------------------------------------- // Platform Defines //---------------------