1.1代码修改注释
用注释块方式保留原有代码。
对多行代码的修改，需要用显著的注释条标明新代码的范围。
在新代码前以注释块方式说明以下内容：一、修改人；
二、修改时间；三、修改内容。
对修改后代码的再修改仍采用上述方式。
当某源代码文件修改次数较多，以致影响阅读时，可以将该源代码文件复制成备份文件（备份文件后缀可
依时间顺序编为*.b01，*.b02，*.b03，等等），然后
删除代码中保留的所有旧代码、修改注释等内容。
程序版本做大的升级时，在保留原版本代码的前提下，可以删除代码中保留的旧代码、修改注释等内容。
例如：
新添加的代码行的注释
///add begin 新增时间新增人新增目的
添加的源代码
///add end
修改的代码行的注释
///modify begin 修改时间修改人修改目的
修改的源代码
///modify end
删除的代码行的注释
#region 删除块注释
///delete begin 删除时间删除人删除目的
删除的源代码///delete end #endregion
设置注释模板的入口：Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍： 文件(Files)注释标签： /** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo} * @author chenguang * @date ${date} ${time} * @version V1.0 */ 类型(Types)注释标签（类的注释）： /** * 类功能说明 * 类修改者修改日期 * 修改说明 * Title: ${file_name} * Description:清大海辉科技开发平台 * Copyright: Copyright (c) 2006 * Company:北京清大海辉科技有限公司 * @author ${user} * @date ${date} ${time} * @version V1.0 */ 字段(Fields)注释标签： /** * @Fields ${field} : ${todo} */ 构造函数标签： /** * Title: * Description: * ${tags} */
方法(Constructor & Methods)标签： /** * 函数功能说明 * ${user} ${date} * 修改者名字修改日期 * 修改内容 * @param ${tags} * @return ${return_type} * @throws */ getter方法标签： /** * @return ${bare_field_name} */ setter方法标签： /** * @param ${param} ${bare_field_name} */ 加注释快捷键：选中你要加注释的方法或类，按Alt + shift + J。
Eclipse自动添加注释 我们在用Eclipse开发工具编写代码时，常常需要在类的头部加上一下注释，标明类的作者，创建时间等等。我们常用的做法是： 方式1：在新建类时勾选：Generate comments 如图1。 图1 创建类时指定生成注释 这种方式固然可以生成，但是只会是Eclipse默认的，仅有@author xxxx
方式2：快捷键生成 第二种就是我们生成类的时，也许忘了勾选。那么我们就会使用Eclipse提供的快捷键ctrl+alt+j 图2 快捷键添加注释 当然这种方式也需要开发者，现将鼠标定位类名行或者方法名行。然后生成对应的注释。那么如果我们想要自己定义自己的注释呢？ 方式三：自动生成自定义注释 Eclipse最大好处就是很多东西都能让开发者自己来定义。下面说说如何自定义生成注释。 3.1首先自定义注释模板 打开：windows-->preference -->Java-->code style -->code templates --> code -->new java file 按照如上操作打开到相应对话框，如下图3
图3：注释模板对话框 当进入到这个对话框后，点击右侧“Edit”编辑按钮，进入到注释模板编辑对话框，如下图4：
图4 编辑自定义注释模板 在这个对话框中编辑你想要的注释模板，编辑完成后点击OK。 附：注释基本模板： 当点击OK退出模板编辑对话框后，勾选：automatically add comments for new methods and types，如图5
图5 设置自动添加注释 当然，你还可以设置很多注释，包括getter、setter等等的注释，都在这里，有兴趣的你都可以多试试。
1.编程规范 (一)命名规范 1.【强制】所有编程相关的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束 反例：_name / name_ / $name / name$ 正例：name 2.【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。 说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。 反例：XingMing [姓名] /xingBie() [性别] 正例：name[姓名] sex[性别]等国际通用的名称，可视为英文。 3. 【强制】类名使用UpperCamelCase(第一个词的首字母，以及后面每个词的首字母都大写，叫做“大骆驼拼写法”) 风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名）DO / DTO / VO / DAO 等。正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
4. 【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase (第一个词的首字母小写，后面每个词的首字母大写，叫做“小骆驼拼写法”)风格，必须遵从驼峰形式。 正例： localValue / getHttpMessage() / inputUserId 5. 【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。 正例： MAX_STOCK_COUNT 反例： MAX_COUNT 6. 【强制】抽象类命名使用 Abstract或Base 开头；异常类命名使用 Exception结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。 7. 【强制】中括号是数组类型的一部分，数组定义如下：String[] args; 请勿使用String args[]的方式来定义 8. 【强制】POJO类中的任何布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错误。 反例：定义为基本数据类型 boolean isSuccess；的属性，它的方法也是isSuccess()，RPC框架在反向解析的时候，“以为”对应的属性名称是 success，导致属性获取不到，进而抛出异常。
? 一个通用的Java文件上传类，支持上传图片，支持生成缩略图，设置最大上传文件字节数，不设置时默认10M，可接收来自表单的数据，当有多个文件域时， 只上传有文件的，忽略其他不是文件域的所有表单信息，支持用户对上传文件大小, 字节进行设置，本上传类可过滤掉以下文件类型：".exe", ".com", ".cgi", ".asp", ".php", ".jsp"等，你可自已添加过滤的文件后缀，上传文件时如果没有上传目录，则自动创建它。。。 ? package com.gootrip.util; import java.io.File; import java.util.*; import https://www.doczj.com/doc/b57206656.html,mons.fileupload.*; import javax.servlet.http.HttpServletRequest; import java.util.regex.Pattern; import java.io.IOException; import https://www.doczj.com/doc/b57206656.html,mons.fileupload.servlet.ServletFileUpload; import https://www.doczj.com/doc/b57206656.html,mons.fileupload.disk.DiskFileItemFactory; import java.util.regex.Matcher; /** * TODO 要更改此生成的类型注释的模板，请转至 * 窗口－首选项－ Java －代码样式－代码模板 */ public class FileUploadUtil {
//当上传文件超过限制时设定的临时文件位置，注意是绝对路径 private String tempPath = null; //文件上传目标目录，注意是绝对路径 private String dstPath = null; //新文件名称，不设置时默认为原文件名 private String newFileName = null; //获取的上传请求 private HttpServletRequest fileuploadReq = null; //设置最多只允许在内存中存储的数据,单位:字节，这个参数不要设置太大 private int sizeThreshold = 4096; //设置允许用户上传文件大小,单位:字节 //共10M private long sizeMax = 10485760; //图片文件序号 private int picSeqNo = 1; private boolean isSmallPic = false; public FileUploadUtil(){ } public FileUploadUtil(String tempPath, String destinationPath){ this.tempPath = tempPath; this.dstPath = destinationPath; }
程序代码注释编写规范 为提高控制程序的阅读性与可理解性，现制定相关代码程序代码注释编写的编写规范。 一般情况下，源程序有效注释量必须在20％以上，注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。 常规注释有以下两种方式。 单行:以"//"符号开始，任何位于该符号之后的本行文字都视为注释。 多行:以"/*"符号开始，以"*/"结束。任何介于这对符号之间的文字都视为注释。 一、说明性文件 说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。 示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************* COPYRIGHT (C), MicTiVo International. Co., Ltd. File NAME: // 文件 Author: Version: Date: // 作者、版本及完成日期 DESCRIPTION: // 用于详细说明此程序文件完成的主要功能，与其他模块 // 或函数的接口，输出值、取值范围、含义及参数间的控 // 制、顺序、独立或依赖等关系 Others: // 其它内容的说明 Function List: // 主要函数列表，每条记录应包括函数名及功能简要说明 1.... History: // 修改历史记录列表，每条修改记录应包括修改日期、修改 // 者及修改内容简述 1. Date: Author: Modification: 2. .. *************************************************/ 二、源文件头 源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************************ COPYRIGHT (C), MicTiVo International. Co., Ltd. FileName: Author:
文档名称：软件总代码行数_软件注释 率分析 作者: 日期：
1. cncc 1.1 工具简介 度量工具名称cncc 网址https://www.doczj.com/doc/b57206656.html,/ 操作方式命令行 实现语言C++ 适用的操作系统Windows 可以度量的属性code-lines, empty-lines, comment-lines, total-lines 备注 1.2 工具优缺点总结 最新版本 cncc-1-3-1，在sourceforge中2004年已经停止更新。最大的优点是源代码全部存于一个cpp文件，便于集成。 缺点： 1.代码基本没有注释。 2.下载的代码编译有9个错误。 3.费了2个多小时也没搞定。 1.3 使用例程 无。 2. CodeCount 2.1 工具简介 度量工具名称CodeCount 网址https://www.doczj.com/doc/b57206656.html,/downloads421/sourcecode/windows
/control/detail1783204.html 操作方式GUI 实现语言C++ 适用的操作系统Windows 可以度量的属性total-lines, empty-lines, comment-lines, code-lines, 备注 2.2 工具优缺点总结 优点： 工具比较精简，统计源文件总行数、代码行数、空白行数、注释行数，代码有一定的注释。 缺点： 下载的源码是vc7工程，由于机器并没有vc7，利用工具进行工程类型转换，将vc7的工程转换为vc6的工作，编译出错。 核心代码如下： BOOL bCommentSet = FALSE; //注释行统计标识有"/*"时TRUE, "*/"时FALSE BOOL bQuatoSet = FALSE; //字符串统计标识首次一行有奇数个"时TRUE, 下一行有奇数个"时FALSE int nLength = (int)file.GetLength(); CString bufRead; int nLineCommentBegin = 0; while(file.ReadString(bufRead)!=FALSE) { BOOL bStatedComment = FALSE;//本行作为注释行是否已统计过 BOOL bStatedCode = FALSE; //本行作为代码行是否已统计过 nLines++; bufRead.TrimLeft(); //先将文件头的空格或制表符去掉 if(bufRead.GetLength()==0) //为空白行
参考文献与注释的编排方法 一、注释的标注方法 注释是对论著正文中某一特定内容的进一步解释或补充说明,以及未公开发表的私人通信、内部资料、书稿和仅有中介文献信息的"转引自"等类文献的引用著录，排印在该页地脚(数字加圆圈，如①、②...)。 二、参考文献的标注方法 参考文献是作者写作论著时所引用的已公开发表的文献书目,或有明确收藏地点的善本、档案，按照在正文中引用的顺序，用数字加方括号集中列表于文末。正文中的标注方法是：1.引用文献原文需要在正文中标出序号与页码(如："资本主义生产的内在规律在竞争中是以颠倒的形式表现出来的"[1]251)，文后参考文献中不出现页码项;2.引用参考文献中的观点可以只标出序号或者序号与页码同时标注(如：生产力决定生产关系[3]);3.文中多次引用同一参考文献内容，在文后参考文献表中只出现一次，其中不注页码;在正文中标注首次引用的文献序号，并在序号的角标外著录引文页码;4.参考文献的编排格式见附注。 例文 国内外现有的竞争理论文献，或者忽略了马克思的竞争理论，或者只把它作为竞争理论发展的一个阶段或众多竞争理论中的一个流派，停留在马克思对市场竞争过程的描述上。然而,马克思指出："资本主义生产的内在规律在竞争中是以颠倒的形式表现出来的"[1]251。"只有了解了资本的内在本性，才能对竞争进行科学的分析，正像只有认识了天体的实际的、
但又直接感觉不到的运动的人，才能了解天体的表面运动一样。"[2]352 ...... ......而且可以说明，当时政治经济学没有理解的"关于资本主义竞争的基本规律，即调节一般利润率和由它决定的所谓生产价格的规律，也是建立在商品价值和商品成本价格之间的这种差别之上的，建立在由此引起的商品低于价值出售也能获得利润这样一种可能性之上的"[1]45。 ...... ......随着许多偶然的改进,产品系列趋于增大，零件数量趋于增加，会产生大量的多样化成本。[3] 参考文献： [1] 马克思.资本论(第3卷)[M].北京：人民出版社，1975. [2] 马克思.资本论(第1卷)[M].北京：人民出版社，1975. [3] 安德森·派恩二世.21世纪企业竞争的新前沿——大规模定制模式下的敏捷产品开发[M].北京：机械工业出版社，1999. 附注： 一、参考文献著录项目 1. 主要责任者 (专著作者、论文集主编、学位申报人、专利申请人、报告撰写人、期刊文章作者、析出文章作者)。多个责任者之间以"，"分隔，注意在本项数据中不得出现缩写点"."。主要责任者只列姓名，其后不加"著"、"编"、"主编"、"合编"等责任说明。 2.文献题名; 3.文献类型及载体类型标识;
Zdeveloper2.x代码规范1 ZDeveloper命名规范 常见JAVA包命名(以platform插件为例)。 2 公共包 plugins存放所有插件配置文件; lang存放所有插件国际化配置文件; JAVA存放所有插件java类文件; DB目录存放zdm文件。
3 一般情况java包 *.ui子包存放本插件所属UI类(*.ui省略前面的com.zving.platform,下同); *.service子包存放本插件所属扩展服务类; *.service.impl子包存放扩展服务项实现类; *.extend子包存放本插件扩展相关的类( 扩展点接口类或抽象类) ; *.extend.impl子包存放本插件扩展实现类( 扩展行为或其它扩展实现类) ; *.bl子包存放本插件所属后台业务逻辑类。 4 特殊扩展服务用到java包 *.code子包存放本插件所属扩展代码管理扩展服务的扩展项类; *.privilege子包存放本插件扩展菜单权限服务的扩展项类; *.config子包存放本插件扩展配置项扩展服务的扩展项类; *.properties子包存放本插件扩展栏目或站点配置项相关的扩展服务的扩展项类; *.tag子包存放本插件扩展标签服务的扩项类; *.tempalte子包存放本插件扩展模板服务的扩展项类;
( 插件包的命名参展以上方式, 项目需要能够酌情添加有一定意义的子包) 5 插件包 插件包统一以”com.zving.”+插件名称来命名(公司名称域名+插件名称)。 6 插件类 插件名称+”Plugin”, 位于插件所属包根目录下。 7 插件配置文件 ”com.zving.”+插件名称+”.plugin”。 8 UI类 页面名称+”UI”, 类存放位置为”com.zving.”+插件名称+”.ui”子包。
给AndroidStudio加上类注释，方法注释模板2016/09/27 0 给AndroidStudio加上Eclipse一样的注释模板：首先添加方法注释：File- Settings- Editor(展开)- Live Templates(如图示：）然后继续点击图示的加号，这次选择第一个，选择输入的cmt表示在方法前输入cmt回车就会自动添加上注释模板在方法上面输入cmt回车自动可引入模板注释 ?================2016年9月27日23:21:41===================== ?然后是类创建的时候生成的注释模板： ?新建Class类的时候会自动生成： ?方法说明：地址：https://jetbrains/help/idea/2016.2/edit-template-variables-dialog.html ?我的类注释： ?/** * @name ${PROJECT_NAME} * @class name：${PACKAGE_NAME} * @class describe * @anthor ${USER} QQ:1032006226 * @time ${DATE} ${TIME} * @change * @chang time * @class describe */方法注释模板： ?/** * @author $user$ * @time $date$ $time$ * @describe $param$ */ /** * description ：* project name：${PROJECT_NAME} * author : ${USER} * creation date: ${DATE} ${TIME} * @version 1.0 */我只是写在这里，免得重复写，看官自便?tips:感谢大家的阅读，本文由我司收集整编。仅供参阅！
竭诚为您提供优质文档/双击可除 idea,注释模板 篇一：idea快捷键 一常用快捷键 alt+回车导入包,自动修正，当引入的类需要异常捕获的时候 ctrl+shift+space自动补全代码,“new”字符,还可以引入强制转换的ctrl-alt-space可以自动导import类名或接口名提示,以及new后面的提示ctrl+n查找类 ctrl+shift+n查找文件 ctrl+shift+alt+n查找类中的方法或变量 ctrl+shift+alt+s:打开projectstructure ctrl+shift+F7选中文本，高亮显示所有该文本，按esc 高亮消失。ctrl+shift+F9编译类 ctrl+shift+F10运行类 crtl+shift++打开所有关闭的方法，crtl++打开当前关闭的方法 输入/**即可自(idea,注释模板)动写上该方法参数的注释
ctrl-shift-j快捷键把两行合成一行并把不必要的空 格去掉以匹配你的代码格式。ctrl-shift-V快捷键可以将最近使用的剪贴板内容选择插入到文本。使用时系统会弹出一个含有剪贴内容的对话框，从中你可以选择你要粘贴的部分。 ctrl+shift+up/down代码向上/下移动。 ctrl+shift+t自动创建测试类 ctrl+alt+s:打开settings ctrl+alt+l格式化代码 ctrl+alt+o优化导入的类和包 ctrl+alt+V快速为后面生成变量，如new或者方法的返回类型。ctrl+alt+left/right返回至上次浏览的位置ctrl-alt-b可以导航到一个抽象方法的实现代码。 ctrl-alt-t，选中某段代码，可以快速包围用if，try 等。在options|Filetemplates|codetab中你还可以自己定制产生捕捉块的模板。 alt+insert生成代码(如get,set方法,构造函数等) alt+shift+up/down代码向上/下移动。 alt+up/down在方法与类属性间快速移动定位 alt+F1查找代码所在位置 alt+1快速打开或隐藏工程面板 alt+left/right切换代码视图 alt+F3,选中文本，逐个往下查找相同文本，并高亮显
在软件开发的过程中总是强调注释的规范，但是没有一个具体的标准进行说明，通常都是在代码编写规范中简单的描述几句，不能作为一个代码注释检查的标准和依据，做什么都要有一个依据吗:),现在我特整理了一个《Java的注释规范》，内容来自网络、书籍和自己的实际积累。 JA V A注释规范 版本/状态作者版本日期 1.0 ghc 2008-07-02 一、背景 1、当我们第一次接触某段代码，但又被要求在极短的时间内有效地分析这段代码，我们需要什么样的注释信息？ 2、怎么样避免我们的注释冗长而且凌乱不堪呢？ 3、在多人协同开发、维护的今天，我们需要怎么样的注释来保证高质、高交的进行开发和维护工作呢？ 二、意义 程序中的注释是程序设计者与程序阅读者之间通信的重要手段。应用注释规范对于软件本身和软件开发人员而言尤为重要。并且在流行的敏捷开发思想中已经提出了将注释转为代码的概念。好的注释规范可以尽可能的减少一个软件的维护成本, 并且几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护。好的注释规范可以改善软件的可读性，可以让开发人员尽快而彻底地理解新的代码。好的注释规范可以最大限度的提高团队开发的合作效率。长期的规范性编码还可以让开发人员养成良好的编码习惯，甚至锻炼出更加严谨的思维能力。 三、注释的原则 1、注释形式统一 在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其他项目组发现他们的注释规范与这份文档不同，按照他们的规范写代码，不要试图在既成的规范系统中引入新的规范。 2、注释的简洁 内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。 3、注释的一致性 在写代码之前或者边写代码边写注释，因为以后很可能没有时间来这样做。另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。通常描述性注释先于代码创建，解释性注释在开发过程中创建，提示性注释在代码完成之后创建。修改代码的同时修改相应的注释，以保证代码与注释的同步。 4、注释的位置 保证注释与其描述的代码相邻，即注释的就近原则。对代码的注释应放在其上方相邻或右方的位置，不可放在下方。避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释要对齐。 5、注释的数量 注释必不可少，但也不应过多，在实际的代码规范中，要求注释占程序代码的比例达到20%左右。注释是对代码的“提示”，而不是文档，程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱，注释的花样要少。不要被动的为写注释而写注释。 6、删除无用注释
IDEA类和方法注释模板设置 作者：wRitchie 来源：https://www.doczj.com/doc/b57206656.html, IDEA自带的注释模板不是太好用，整理了一下制作了一份比较完整的模板，这里设置的注释模板采用Eclipse的格式，下面先贴出Eclipse的注释模板，我们就按照这种格式来设置： 类注释模板： 方法注释模板： 一、首先我们来设置IDEA中类的模板： 设置类注释模板 1.选择File–>Settings–>Editor–>File and Code Templates–>Includes–>File Header.
2、效果图展示 IDEA没有智能到自动创建方法注释，需手动为方法添加注释，使用Eclipse时我们生成注释的习惯是/**+Enter，也按照这种习惯来设置IDEA的方法注释 1、File-->Settings-->Editor-->Live Templates
（1）新建组：命名为wRitchie （2）新建模板：命名为*
注：因为IDEA生成注释的默认方式是：/*+模板名+快捷键（例：若设置模板名为add，快捷键用Tab，则生成方式为/*add+Tab）若不采用这样的生成方式，IDEA中没有内容的方法将不可用，例如：获取方法参数的methodParameters(）、获取方法返回值的methodReturnType(） （3）设置生成注释的快捷键 （4）设置模板 模板内容如下，注意第一行，只有一个“*”而不是“/*”，在设置参数名时必须用：${参数名}$的方式，否则第五步中读取不到你设置的参数名 * * @Author: wRitchie * @Description: $description$ * @Param: $params$ * @return: $returns$ * @Date: $date$ $time$
《**文学》课程论文布置 总体要求： 1．以小论文方式完成； 2．为让同学认真准备，有足够时间完成，第10周即5月6号统一提交论文； 3．须交手写稿，不交电子稿。请学委按班级学号顺序统一整理后提交给教师； 4．教师阅读后会就作业进行课堂讲解； 5．期中成绩占期末总成绩的30%。请同学认真完成，如果对本次安排有意见或建议， 请及时提出，以便进行修改与改进。 评论**的小说《***》 说明与具体要求： 1．具体题目自行拟定。论文不必过于忧虑写得好坏，重在通过自己的努力，尝试了解、学习论文写作的基本规范与要求，为将来从事论文写作打下基础。 2．要探讨的论题主题不宜太大，要考虑可行性，尽量选一个角度深入研究。尤其注意 言之有据、充实而不发空论。不要写成读后感、作品欣赏或导读。 3．论文篇幅不少于2500字。 4．论文可以借鉴他人，但不能抄袭，用自己的语言和构思。 5．论文格式请参照我在网络教学平台教学材料中上传的学术论文，或者自行查找学习 知网上或图书馆、资料室专业杂志的论文。论文大体包括题目、摘要、关键词、主体、注释、参考文献等几个部分。 6．注意区别注释与参考文献。注释是指在文章中，具体引用了他人的观点、材料处的 注解。注释体例分文内注（在某处加括号的形式注明）、文末注、页脚注。本科生论文一般 以后两种为多，可以任选一种。参考文献一般指整篇文章曾经借鉴而不能或不必具体指出某 处的著作或文章。一般放在整篇论文后面。 7．以下附注释方式。大体可以作两种选择（以下以注释例说明），请根据自己的习惯选 择与学习。 注释方式一： 著作： 作者、著作名、出版者、出版年份、页码（这些要素的位置可以变动，但要求齐全并全文统一）
Java注解(Annotation)
(1) Annotation(注释)是JDK5.0及以后版本引入的。它可以用于创建文档，跟踪代码中的依赖性，甚至执行基本编译时检查。注释是以‘@注释名’在代码中存在的，根据注释参数的个数，我们可以将注释分为：标记注释、单值注释、完整注释三类。它们都不会直接影响到程序的语义，只是作为注释（标识）存在，我们可以通过反射机制编程实现对这些元数据的访问。另外，你可以在编译时选择代码里的注释是否只存在于源代码级，或者它也能在class文件中出现。 元数据的作用 如果要对于元数据的作用进行分类，目前还没有明确的定义，不过我们可以根据它所起的作用，大致可分为三类： 编写文档：通过代码里标识的元数据生成文档。 代码分析：通过代码里标识的元数据对代码进行分析。 编译检查：通过代码里标识的元数据让编译器能实现基本的编译检查。 基本内置注释 @Override Java代码 1. package com.iwtxokhtd.annotation; 2. /** 3. * 测试Override注解 4. * @author Administrator 5. * 6. */ 7. public class OverrideDemoTest { 8. 9. //@Override 10. public String tostring(){ 11. return "测试注释"; 12. } 13. } package com.iwtxokhtd.annotation; /** * 测试Override注解 * @author Administrator * */ public class OverrideDemoTest { //@Override
设置注释模板的入口： Window->Preference->Java->Code Style->Code Template 然后展开Comments 节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍： 文件(Files)注释标签： /** * @Project: ${project_name} * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo} * @author jeffshaw jeff_chon@https://www.doczj.com/doc/b57206656.html, * @date ${date} ${time} * @Copyright: ${year} https://www.doczj.com/doc/b57206656.html, Inc. All rights reserved. * @version V1.0 */ 类(Types)注释标签（类的注释）： /** * @ClassName: ${type_name} * @Description: ${todo} * @author jeffshaw jeff_chon@https://www.doczj.com/doc/b57206656.html, * @date ${date} ${time} * * ${tags} */ 字段(Fields)注释标签： /** * @Fields ${field} : ${todo} */ 构造函数标签： /** * Title: * Description:
* ${tags} */ 方法(Constructor & Methods)标签： /** * @Title: ${enclosing_method} * @Description: ${todo} * @param ${tags} 设定文件 * @return ${return_type} 返回类型* @throws */ 覆盖方法(Overriding Methods)标签： /* (非 Javadoc) * Title: ${enclosing_method} * Description: * ${tags} * ${see_to_overridden} */ 代表方法(Delegate Methods)标签： /** * ${tags} * ${see_to_target} */ getter方法标签： /** * @return ${bare_field_name} */
JAVA编码规范
目录 JAVA编码规范 (1) 1 概述 (8) 1.1范围 (8) 1.2说明 (8) 2 文件体系结构 (10) 2.1文件体系规则 (10) 规则2.1.1 JSP文件目录结构 (10) 建议2.1.2 Java文件目录结构 (10) 2.2源文件结构规则 (11) 规则2.2.3 类变量的声明顺序是public,protected,package,private (11) 规则2.2.4 变量、常量的注释应放在其上方相邻位置 (12) 规则2.2.5 用递增的方式写构造器（比如：参数多的写在后面） (12) 规则2.2.6 类变量的存取方法：get和set方法 (12) 规则2.2.7 如果定义main() 方法，必须将main方法写在类的底部 (12) 3 文件命名规则 (13) 规则3.1S TRUCTS配置文件命名............................................... 错误!未定义书签。 规则3.2JSP文件命名 (13) 规则3.3J AVA文件命名 (13) 4 排版规则 (14)
4.1语句排版规则 (14) 规则4.2.1简单语句每行至多包含一条语句 (14) 规则4.2.2 复合语句被括其中的语句缩进一个层次 (14) 规则4.2.3 左大括号"{"应位于复合语句起始行的行尾，前面需加一个空格符；右大括号"}"应另起一行并与复合语句首行对齐。 (14) 规则4.2.4 必须用"{"和"}"将if内的语句括起来。(即使只有一条语句的情况下) (14) 规则4.2.7 在多层嵌套的for语句中，应在for上一行增加逻辑注释 (15) 建议4.2.14 “=”等比较符前后加一个空格 (15) 5 注释规则 (16) 5.1类注释规则 (16) 规则5.1.1 使用JavaDoc，列出功能、版本信息、日期、作者和版权声明 (16) 规则5.1.2 如果对文件进行了修改，必须说明修改目的、修改日期、修改人，并变更版本信息 (16) 5.2类方法注释规则................................................................. 错误!未定义书签。 规则5.2.1 用中文写出每个参数和返回值的含义 (16) 规则5.2.2 当修改其他组员创建的类时，增加author标签错误!未定义书签。 5.3单行注释规则..................................................................... 错误!未定义书签。 规则5.4.1单行注释位于所描述内容之前 ...................... 错误!未定义书签。 规则5.4.2 单行注释之前留一行空行 ............................. 错误!未定义书签。
程序代码写作规范（草案）（版本：1.0） ●基本要求 (1)程序结构清析，简单易懂，单个函数的程序行数不得超过100行。 (2)打算干什么，要简单，直接了当，代码精简，避免垃圾程序。 (3)尽量使用公共函数，c51的标准库函数谨慎使用。 (4)不要随意定义全局变量，尽量使用局部变量。 (5)使用括号以避免二义性。 (6)非万不得已不要使用浮点运算。一般的小数运算可以使用定点数实现。 ●可读性要求 (1)可读性第一，效率第二。 (2)保持注释与代码完全一致。 (3)每个源程序文件，都有文件头说明，说明规格见规范。 (4)每个函数，都有函数头说明，说明规格见规范。 (5)主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。 (6)常量定义（define）有相应说明。 (7)处理过程的每个阶段都有相关注释说明。 (8)在典型算法前都有注释。 (9)利用缩进来显示程序的逻辑结构，缩进量一致并以4个空格为单位。 (10)循环、分支层次不要超过五层。 (11)注释可以与语句在同一行，也可以在上行。 (12)空行和空白字符也是一种特殊注释。 (13)一目了然的语句不加注释。 (14)注释的作用范围可以为：定义、引用、条件分支以及一段代码。 ●结构化要求 (1)禁止出现两条等价的支路。 (2)非必要不要使用goto语句。goto一般用于从内循环直接跳到循环外部、检测到错误直接跳到错误处理程序。影响可读性时禁止使用goto语句。 (3)用if 语句来强调只执行两组语句中的一组。
(4)用case 实现多路分支。 (5)避免从循环引出多个出口。 (6)尽量减少函数的出口。 (7)避免不必要的分支。 (8)不要轻易用条件分支去替换逻辑表达式。 ●正确性与容错性要求 (1)程序首先是正确，其次是优美。 (2)无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查。 (3)改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响。 (4)所有变量在调用前必须被初始化。 (5)对所有的用户输入，必须进行合法性检查。 (6)不要比较浮点数的相等，如：10.0 * 0.1 == 1.0 ，不可靠。 (7)函数对接受的参数应该进行合法性检查。 (8)单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。 (9)尽量不要使用==作为判断条件，应该用>=,或<=替代。 ●可重用性要求 (1)所有c语言程序文件只包含一个头文件config.h，在config.h中包含其它头文件。 (2)重复使用的完成相对独立功能的算法或代码应编入一个文件，并且使用头文件 (3)设定一些与硬件相关的参数，这些参数在config.h中定义，模块自己的头文件仅说明如何设定这些参数。 (4)公共代码应考虑OO思想，减少外界联系，考虑独立性或封装性。 (5)尽量少使用与编译器相关的特性。 (6)取变量占用内存长度用"sizeof(变量类型)"而不用常量。 ●命名规则 ?变量命名 (1)命名必须具有一定的实际意义，要“望文知义”。 (2)根据变量的作用域决定名字的长短。作用域越大，名字越长。在整个程序中都要使用的变量就要长一些；而局部变量就可以短一些。 (3)变量名中每一个单词首字母大以分隔单词。一些习惯单词如OK可以全部大写。 (4)局部变量中可采用如下几个通用变量：Temp，N，i，j（一般用于循环变量）。