代码要是没有注释,对读者来说就是一堆乱七八糟的字母,为了提高代码的可读性和可维护性,必须对代码进行必要的注释,这里小编整理了一下java注释规范. (一)技巧 1:注释当前行快捷方式:ctrl+/ 2:/* */  选上要注释的代码 ctrl+Shift+/ (二)在哪些地方加注释? 1:每个源文件开头都应有一组注释,包含代码的作者,时间: 2:当编写的代码较长,并且包含了多层嵌套时,花括号会比较多,比较乱,为了方便阅读,应该在某些段落结束的地方加注释,注明该闭合花括号对应的起点: 3:每个方法

Version:0.9 StartHTML:-1 EndHTML:-1 StartFragment:00000099 EndFragment:00018736 在软件开发的过程中总是强调注释的规范,但是没有一个具体的标准进行说明,通常都是在代码编写规范中简单的描述几句,不能作为一个代码注释检查的标准和依据,做什么都要有一个依据吗:),现在我特整理了一个<Java的注释规范>,内容来自网络.书籍和自己的实际积累.JAVA注释规范 版本/状态 作者 版本日期 1.0 ghc 2008-07-02

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

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

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

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

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

一.命名规范 1. 项目名全部小写 2. 包名全部小写(除非部分是缩写) 3. 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写. 如:public class MyFirstClass{} 4. 变量名.方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写.即:驼峰法则. 如:int index=0; public void toString(){} 5. 常量名全部大写 如:public static final String GAME_COLOR=”RED”;

为使开发人员养成良好的开发习惯,编写可读性强.易维护的程序,结合以往资料,现整理Java编码规范,将之作为开发人员的参照依据. 一.排版 1.相对独立的程序块之间必须加空行 下列情况应该使用一个空行: 两个方法之间 方法内的局部变量和方法的第一条语句之间 块注释或单行注释之前 一个方法内的两个逻辑段之间 2.单行长度不超过120个字符,如超出则换行,且操作符应放在行首,新行要有相对缩进 3.多个参数之间,二元运算符左右,for语句表达式之间应用空格隔开 表达式之间用空格隔开 4.多个短语句不要写

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

注释规范 1.   类注释 在每个类前面必须加上类注释,注释模板如下: 2.   属性注释 在每个属性前面必须加上属性注释,注释模板如下: 3.   方法注释 在每个方法前面必须加上方法注释,注释模板如下: 4.   构造方法注释 在每个构造方法前面必须加上注释,注释模板如下: 5.   方法内部注释 在方法内部使用单行或者多行注释,该注释根据实际情况添加. 如: Color bgColor = Color.RED    //背景颜色

[java] 注释以及javadoc使用简介-汇率换算器的实现-插曲3 // */ // ]]>   [java] 注释以及javadoc使用简介-汇率换算器的实现-插曲3 Table of Contents 1 系列文章地址 2 本文动机介绍 3 javadoc介绍 4 注释分类–按范围分 5 常用的标签 6 针对包的注释 7 针对类和接口的注释 8 针对方法的注释 9 其他字段的注释 10 在"汇率转换器"源代码中添加注释 11 执行javadoc, 并且使得中文正常显示 1

一.规范存在的意义 应用编码规范对于软件本身和软件开发人员而言尤为重要,有以下几个原因: 1.好的编码规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护: 2.好的编码规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码: 3.好的编码规范可以最大限度的提高团队开发的合作效率: 4.长期的规范性编码还可以让开发人员养成好的编码习惯,甚至锻炼出更加严谨的思维: 二.命名规范 1.一般概念     1.尽量使用完整的英文描述

java中的注释分为实现注释和文档注释 实现注释就是那些/……../和//……的注释,是注释程序用的,文档注释是/*……./的注释,是用来生成javadoc的.设置方法如下: 1.打开Eclipse的偏好设置:  2.依次选择Java > Code Style > Code Template > Comments:  一.文件注释 文件头注释以 /开始,以/结束,其中列出类名,版本信息,日期和版权声明. 选择comments下的Files,点击Edit进行编辑:  /* * ${f

   软件开发技术规范 PTHINK-DEVELOP-JAVA-091010         Java语言编程规范   2009-10-10发布                2009-10-11实施 目       次 前言 ..........................................................................3 1  范围 2  规范性引用文件 3  术语和定义 4  排版规范 4.1 规则 1.*程序块要采用缩进风格编写,缩进的

编码规范体现出一个开发者的基本素质,良好的编码规范可以提高团队编码的效率,避免很多不必要的问题.今天分享一个标准的Java编码规范给大家,希望对于大家今后的开发工作带来帮助. 编码规范的意义         在项目开发维护中,编码规范作为开发规范的一个组成部分,是十分重要和必须的,它不仅仅是为了提高开发效率,也有利于降低后期维护开发的成本.编码规范的根本目的就是要让不仅代码可以一目了然,也可以很容易的理解开发人员所编写的代码程的用途和意义.由此,用来减少项目中因为开发维护人员的更替或由于长时间不

下面总结以点java命名规范 虽然感觉这些规范比起C#来说有点怪,但还是应该尊重它的命名! 命名规范 项目名全部小写 包名全部小写 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写. 变量名.方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写. 常量名全部大写 所有命名规则必须遵循以下规则: . 名称只能由字母.数字.下划线.$符号组成 . 不能以数字开头 . 名称不能使用JAVA中的关键字. . 坚决不允许出现中文及拼音命名. 注释规范 1 类注释 在每个类前面

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

编码规范 转载于:https://www.cnblogs.com/ftl1012/p/javaCode.html 1 前言为确保系统源程序可读性,从而增强系统可维护性,java编程人员应具有基本类似的编程风格,兹制定下述Java编程规范,以规范系统Java部分编程.系统继承的其它资源中的源程序也应按此规范作相应修改. 2 适用范围本文档将作为java编程人员软件开发的编程格式规范.在项目Java部分的编码.测试及维护过程中,要求严格遵守. 3 命名规范定义这个规范的目的是让项目中所有的文档都看起

前言 一种工具被发明出来,那么针对这种工具的各种使用规则.条条框框就随之而来.无规矩不成方圆,无制度则无国家,无风格不成代码!治国有国法.排兵布阵有章法.那么写代码也有它界内通用的不成俗的约定.最近刚好在看alibabaJava开发手册,只听说是业界内通用的Java代码规范小红书.这不也刚转入Java的阵营,怎的也不能落人之后啊.树要皮,人要脸,程序员的脸不就你写的那一手老代码嘛!!此书分为好几大块,我没有读完,但只针对基本Java代码规范做了阅读,然好记性不如烂笔头,遂以本文以录之. 命名风格