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

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

一.开发工具规范: 1. 开发工具经项目负责人调试后统一确定. 2. 开发工具一经确定不允许集成任何非统一插件,若有需要,经项目负责人同意后统一为 项目组成员添加. 3. 开发工具的编码格式不允许修改. 二.排版规范: 1. 关键词(或变量)和操作符之间加一个空格. 例如:int iCont = 1;//操作符和值之间有一个空格. 2. 相对独立的代码块与块之间加空行. 例如:两个方法之间需要用空格隔开. 3. 较长的语句.表达式等要分成多行书写. 4. 长表达式要在低优先级操作符处划分新行,操…

目标说明 统一良好的代码格式规范可以有效提升开发团队之间的「协作效率」,如果不同的开发团队或者开发人员采用不同的代码格式规范,那么每次Format代码都会导致大量的变化,在Code Review及Merge代码时会带来很多的干扰项.因此制定本代码规范希望达成以下目标: 统一Java代码格式规范,确保团队成员间「代码风格一致」: 保证Format代码时不会引入格式上的干扰: 提升团队协作效率.Code Review效率: 怎么实施 在Java代码规范方面目前Google Java Code Sty…

PHPDocument 代码注释规范 1. 安装phpDocumentor(不推荐命令行安装)在http://manual.phpdoc.org/下载最新版本的PhpDoc放在web服务器目录下使得通过浏览器可以访问到点击files按钮,选择要处理的php文件或文件夹还可以通过该指定该界面下的Files to ignore来忽略对某些文件的处理.然后点击output按钮来选择生成文档的存放路径和格式.最后点击create,phpdocumentor就会自动开始生成文档了. 2．如何写PHP规范注…

eclipse中添加Java代码注释模板 1.Window->Preference->Java->Code Style->Code Template,进入注释编辑界面 2.文件(Files)标签注释 3.类型(Types)标签注释(类的注释) 4.字段(Fields)标签注释 5.构造函数(Constructor )标签 6.方法(Methods)标签注释 7.覆盖方法(Overriding Methods)标签注释 8.代表方法(Delegate Methods)标签注释 9.G…

1. 引言     团队开发时,业务模块分配的越清晰,代码注释管理越完善,越有利于后面维护,后面再管理也方便不少.另外也起着"文字砖"的作用,你懂的.注释不需要很详细,把代码块方法块功能简述一下就行.不然三月后回头看就要骂人了,骂完发现是自己写的,啧啧啧...     三种常用的 Java 注释方式 // 声明常量 int number; /* * 类主函数 */ public static void main(String[] args) { } /** * @param maste…

一.目的 1.  为什么需要注释规范? 注释规范对于程序员而言尤为重要,有以下几个原因: 一个软件的生命周期中,80%的花费在于维护. 几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护 注释规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码 统一的注释规范可以快速生成文档说明 二.注释说明 Java 程序有两类注释:归档(文本/文档)注释(document comments)和实现注释(implementation comments). 归档注释:采用java do…

最近回过头来给以前的项目增加功能,发现之前写的注释非常不全,代码也非常的不整洁,有些地方写的''窝七八烂的,看着很不舒服:又恰好经理最近也经常跟我提起代码规范,我们就讨论了一下代码规范的重要性和必要性,于是决定我们也要制定个规范,这样利于团队开发,统一代码风格,写出来的代码也不会风格迥异: 最近几天有空就跟其他公司的盆友聊起这件事,越发觉得代码规范的必要性,于是根据其他公司盆友以及自己整理的一些细节制定了一套规范,作为公司团队开发的代码规范. 代码编写一些规范 首先Java实例三大原则: 1.必…

0. 安装阿里代码规范的eclipse插件 https://www.cnblogs.com/caer/p/7753522.html 1.基本原则 强制性原则:     1.字符串的拼加操作,必须使用StringBuilder:     2.try…catch的用法   try{ }catch{Exception e e.printStackTrace(); }finally{ }//在最外层的Action中可以使用,其它地方一律禁止使用:   try{ //程序代码 }catch(Excepti…

编码规范 1 前言为确保系统源程序可读性,从而增强系统可维护性,java编程人员应具有基本类似的编程风格,兹制定下述Java编程规范,以规范系统Java部分编程.系统继承的其它资源中的源程序也应按此规范作相应修改. 2 适用范围本文档将作为java编程人员软件开发的编程格式规范.在项目Java部分的编码.测试及维护过程中,要求严格遵守. 3 命名规范定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失. 3.1 Package 的命名Packa…

今天在查看曾经写过的代码时发生了一件很是让人头疼的事: 我写的所有注释全部都变成了了乱码,曾经刚入门时也是经常遇到类似的问题,解决起来很快,每天可能都会在工作空间里看到,但是随着时间的推移,写代码的规范也越来越标准,这类问题很少遇到,于是它就随着时间淡化了,今天我可是挠破了头皮在解决掉这个麻烦,下面看分析: Eclipse JAVA文件注释乱码将别人的项目或JAVA文件导入到自己的Eclipse中时,常常会出现JAVA文件的中文注释变成乱码的情况,主要原因就是别人的IDE编码格式和自己的Ecli…

编码规范 1 前言为确保系统源程序可读性,从而增强系统可维护性,java编程人员应具有基本类似的编程风格,兹制定下述Java编程规范,以规范系统Java部分编程.系统继承的其它资源中的源程序也应按此规范作相应修改. 2 适用范围本文档将作为java编程人员软件开发的编程格式规范.在项目Java部分的编码.测试及维护过程中,要求严格遵守. 3 命名规范定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失. 3.1 Package 的命名Packa…

Eclipse JAVA文件注释乱码将别人的项目或JAVA文件导入到自己的Eclipse中时,常常会出现JAVA文件的中文注释变成乱码的情况,主要原因就是别人的IDE编码格式和自己的Eclipse编码格式不同. 总结网上的建议和自己的体会,可以参考以下几种解决方式: 1 改变整个文件类型的编码格式1) eclipse->window->preferences->General->Content Types2) 找到要修改的文件的类型(JAVA,JSP等等),在下面有个Default…

前言: lombok简介: lombok是暑假来到公司实习的时候发现的一个非常好用的小工具,刚见到的时候就感觉非常惊艳,有一种相见恨晚的感觉,用了一段时间之后感觉的确挺不错,所以特此来推荐一下. 那么lombok到底是个什么呢,lombok是一个可以通过简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的 Java 代码的工具,简单来说,比如我们新建了一个类,然后在其中写了几个字段, 然后通常情况下我们需要手动去建立getter和setter方法啊,构造函数啊之类的,lombok的作用就是…

规范需要平时编码过程中注意,是一个慢慢养成的好习惯 1.基本规则 1.注释应该使代码更加清晰易懂   2.注释要简单明了,只要提供能够明确理解程序所必要的信息就可以了.如果注释太复杂说明程序需要修改调整,使设计更加合理.   3.注释不仅描述程序做了什么, 还要描述为什么要这样做,以及约束   4.对于一般的getter.setter方法不用注释   5.注释不能嵌套   6.生成开发文档的需要用中文编写 2.三种注释方式说明 1.文档注释 /** */ 可以对用多行,一般用来对类.接口.成员方…

前言: visualVM: 运行java程序的时候启动visualvm,方便查看jvm的情况 比如堆内存大小的分配:某个对象占用了多大的内存,jvm调优必备工具. checkstyle: CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具. 它能够自动化代码规范检查过程,从而使得开发人员从这项重要,但是枯燥的任务中解脱出来. CheckStyle检验的主要内容: 1):Javadoc注释:   2):命名约定:   3):·标题   …

1. Java 命名约定 除了以下几个特例之外,命名时应始终采用完整的英文描述符.此外,一般应采用小写字母,但类名.接口名以及任何非初始单词的第一个字母要大写. 1.1 一般概念 * 尽量使用完整的英文描述符 * 采用适用于相关领域的术语 * 采用大小写混合使名字可读 * 尽量少用缩写,但如果用了,要明智地使用,且在整个工程中统一 * 避免使用长的名字(小于 15 个字母是个好主意) * 避免使用类似的名字,或者仅仅是大小写不同的名字 * 避免使用下划线(除静态常量等) 1.2 示范 * 包(P…

单行注释: 选中代码,按下ctrl+/ 一条代码单行注释:选中一条代码按下ctrl+/,则为一条代码单行注释: 多条代码单行注释:选中多条代码按下ctrl+/,则为多条代码单行注释: 取消注释:对已经注释好的代码选中再次按下ctrl+/,则取消注释. public class PrintDemo { public static void main(String[] args) { // System.out.print("Hello"); 一条代码单行注释 // System.out.…

前言: P3C插件 是阿里巴巴p3c项目组进行研发.这个项目组是阿里巴巴开发爱好者自发组织形成的虚拟项目组,根据<阿里巴巴Java开发规范>转化而成的自动化插件,并且实现了部分自动编程. 插件使用简易教程(基于IDEA): 1):打开 Settings---->Plugins---> 进行搜索--->选择---->"Alibaba Java Coding Guidelines" ----> install 安装插件:点击插件详情中的"…

代码优化的目标是 减小代码的体积 提高代码运行的效率 代码优化细节 1.尽量指定类.方法的final修饰符 带有final修饰符的类是不可派生的.在Java核心API中,有许多应用final的例子,例如java.lang.String,整个类都是final的.为类指定final修饰符可以让类不可以被继承,为方法指定final修饰符可以让方法不可以被重写.如果指定了一个类为final,则该类所有的方法都是final的.Java编译器会寻找机会内联所有的final方法,内联对于提升Java运行效率作…

1.Doxygen简介 Doxygen是一个程序的文档产生工具,可以将程序中的注释转换成说明文档或者说是API参考手册,从而减少程序员整理文档的时间.当然这里程序中的注释需要遵循一定的规则书写,才能让Doxygen识别和转化. 目前Doxygen可处理的程序语言包含C/C++.Java.Objective-C.IDL等,可产生出来的文档格式有HTML.XML.LaTeX.RTF等,此外还可衍生出不少其它格式,如HTML可以打包成CHM格式,而LaTeX可以通过一些工具产生出PS或是PDF文档等.…

文件注释 文件注释位于文件的最前面,应包括文件的以下信息:概要说明及版本(必须)项目地址(开源组件必须)版权声明(必须)开源协议(开源组件必须)版本号(必须)修改时间(必须),以ISO格式表示(可使用Sublime Text的InsertDate插件插入)文件注释必须全部以英文字符表示,并存在于文件的开发版本与生产版本中.例如: /*!  * jRaiser 2 Javascript Library  * waterfall - v1.0.0 (2013-03-15T14:55:51+0800)…

特殊注释: 1 TODO 表示需要实现,但目前还未实现的功能 2 XXX 勉强可以工作,但是性能差等原因 3 FIXME 代码是错误的,不能工作,需要修复 TODO: + 说明:如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明. FIXME: + 说明:如果代码中有该标识,说明标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明. XXX: + 说明:如果代码中有该标识,说明标识处代码虽然实现了功能,但是实现的方法有待商榷,希望将来…

原文:http://blog.csdn.net/pleasecallmewhy/article/details/8658795 1 源文件头部注释 列出:版权.作者.编写日期和描述. 每行不要超过80个字符的宽度. 示例: [cpp] view plaincopy /************************************************* Copyright:Call_Me_Why Author:why Date:2010-08-25 Description:Somet…

一.注释格式分类: 1.单行(single-line)注释://…… 2.块(block)注释:/*……*/ 3.文档注释:/**……*/ javadoc有如下: 二.加注释的场景: 1. 基本注释(必须加) (a)类(接口)的注释 (b)构造函数的注释 (c)方法的注释 (d)全局变量的注释 (e)字段/属性的注释 2. 特殊必须加注释(必须加) (a)典型算法 必须有注释. (b)在代码不明晰处必须有注释. (c)在代码修改处加上修改标识的注释. (d)在循环和逻辑分支组成的代码中加注释.…

1定义java文件头部的注释 2给java类中的方法添加上注释 2.1第一步勾选Enable Live  Templates 2.2第二步新建一个Group 2.3第三步新建一个Template 2.4第四步点击Define按钮 2.5第五步填写注释模板 1.定义java文件头部的注释 打开设置面板,然后填写注释模板: File  => setting  => editor =>  File and Code Templates 如图: 2.给java类中的方法添加上注释 2.1.第一步…

 前言: 检测代码中可能的bug及不规范的位置,检测的模式相比p3c更多,写完代码后检测下 避免低级bug,强烈建议用一下,一不小心就发现很多老代码的bug. 使用步骤: 1):打开 Settings---->Plugins---> 进行搜索--->选择---->"FindBugs-IDEA" ----> install 安装插件:点击插件详情中的"install"按钮,按照其提示即可完成安装,安装完成后需重启IDEA. 会发现左下角会…

前言: 最近在Jetbrains IDEA插件网站逛发现了 Rainbow Brackets这款插件,非常棒,推荐给大家. 可以实现配对括号相同颜色,并且实现选中区域代码高亮的功能. 对增强写代码的有趣性和排错等都有一些帮助. 安装步骤: 1):打开 Settings---->Plugins---> 进行搜索--->选择---->"Alibaba Java Coding Guidelines" ----> install: 安装插件:点击插件详情中的&qu…

1.单行注释      //: //后到本行结束的所有字符会被编译器忽略; 2.多行注释     /* */: /*  */之间的所有字符会被编译器忽略 3.文档注释     /** */: 在/**  */之间的所有字符会被编译器忽略,java特有的(用于生成文档); 我的总结:多行和文档注释都不能嵌套使用.…