`

JAVA编码规范

阅读更多
看到国内某公司的编码规范,总结了一下:
1.顺序:变更履历
        Package声明
        Import声明
        Class Header
       Class
       常量(Menifest Variables)
        成员变量(Instance Variables)
        初始Block(initializer Blocks)
        构造器(Constructors)
        属性(Properties)
        方法(Public Method)
        方法(Protected Methods)
        方法(Private Methods)
        内部类(Inner Class)
        测试方法(Test Main)

2.标准的package名可以分为三部分:<公司名>.<应用程序名>.<包名>;全部为小写字母

3.“Class Header”可以分为3部分——说明部分、版本信息和其他信息,中间使用NULL行分割。
 程序中的每一个类都必须有Class注释。根据需要,Class注释中除了说明部分不能省略外,版本信息和其他信息都可以省略。
 Class注释中的说明部分的写法参考范例,根据需要,可以省略其中的一些说明部分(可省略的部分后标有可选)。

4.Class的名称应该是一个名词短语。 可以是“形容词/名词 + 名词”的形式。 例如InputDataStream、Developer、OrderItem等。Class的名称由1个或1个以上的英语句单词组成, 其中每一个英语句单词的首字母应该大写, 其余字母小写。

5.类成员变量的名称使用26个英文字母并且规定使用下划线“_”开头。

6.如果缺省构造器中没有任何代码,则应使用“//null”标注
public MyClass() { //正确
        //null
    }

7.在方法内部的注释要写明Why,而不是What

8.当Class名由多个单词组成时,每个单词的第1个字母(段落)都要大写;例外Class名的最后要加上“Exception”;Interface的命名规则基本上要基于Class名。统一此写法,将提高代码的易读性。如果需要与Class名区分,请在开头加上“I”。

9.关于Method名,只有一个单词时,全部采用小写字。当由多个单词组成时,第2个以后的单词的第1个字母要大写;生成Object的Method名的格式是“"create"+Object名”;
转换Method名的格式是“"to"+Object名”
Getter Method名的格式是“"get"+属性名”
Setter Method名的格式是“"set"+属性名”
boolean 通过返回变量的Method名要能看出true/false的状态

10.变量命名:
通过boolean变量要能看出true/false的状态;
常量全部为static final、全部是大写字、段落用“_”
变量名要反映其作用
Instance变量名的格式是“"_"+变量名”
Instance的字段名全部使用大写字

11.控制语句规范:
关于for语句的循环计数器,各嵌套分别使用"I"、"j"、"k"…等
控制语句(if, else, while, for, do while)的“{ }”是不可省略的
在利用了for语句的重复处理中,不更改循环变量的值
for语句的计数从0开始
使用break及continue将变得难懂
不要在循环内生成对象

12.命令语句风格规范
return语句不使用括号
boolean变量已比较完毕
不等号要向左("<"、"<=")
不轻易重复使用Local变量
在单一Method中不能使用4次以上否定运算符“!”
表示long型的常量时,使用“L”而不是“I”
不使用嵌套的赋值

13.声明语句风格规范
1个Statement中有1个变量声明
数组声明形式为“型名[]”
变量声明要有初始值

14.书写格式规范
不使用Tab,而且使用空白字符
缩进量是4个空白字符
避免过长的行
在"{"之后不写Statement
在逗号之后输入空白字符
在赋值运算符(=, +=, -=, …)前后输入空白字符
在for语句内的分号之后输入空白字符
在“++”及“--”和运算数之间不输入空白字符
在Bit运算符("|"、"&"、"^"、"<<"、">>")的前后输入空白字符
在逻辑运算符("||"、"&&")的前后输入空白字符
在关系运算符("<"、">"、">="、"<="、"=="、"!= ")的前后输入空白字符
在算术运算符("+"、"-"、"*"、"/"、"%")的前后输入空白字符
在条件运算符“?”的前后分别输入1个空白字符
最后写main()
禁止使用System.out.println输出(为了控制系统中的日志输出,原则上禁止使用System.out.println输出。调试阶段的System.out.println输出在发布时应该注释掉)


确实,规范的编码容易阅读,容易进行维护,也很美观,不过这些多的细节还得在以后的编码过程中慢慢的养成……






分享到:
评论

相关推荐

    阿里巴巴java编码规范

    阿里巴巴java编码规范 ,Java 并发编程培训(阿里巴巴) 《阿里巴巴Java开发手册》,首次公开阿里官方Java代码规范标准。这套Java统一规范标准将有助于提高行业编码规范化水平,帮助行业人员提高开发质量和效率、大大...

    华为JAVA编码规范.pdf

    华为JAVA编码规范.pdf 华为JAVA编码规范.pdf是华为公司编写的JAVA编程语言编码规范,旨在提供一个统一的编程风格和代码组织方式,以提高代码的可读性、维护性和可重用性。该规范涵盖了编程语言的基本结构、命名规则...

    腾讯java编码规范

    腾讯 Java 编码规范 腾讯 Java 编码规范是腾讯集团管理标准的一部分,旨在确保公司项目代码的易维护性和编码安全性。该规范涵盖了 Java 编码风格、文件组织、代码风格、注释、命名、声明、异常、习惯等方面。 一、...

    Java编码规范.docx

    Java 编码规范 Java 编码规范是指在 Java 语言中编写代码时需要遵守的一些约定和规则,以确保代码的可读性、可维护性和可扩展性。本文将对 Java 编码规范的主要内容进行详细讲解。 命名风格是 Java 编码规范的重要...

    java编码规范考试题答案.doc

    "java编码规范考试题答案" 一、Java编码规范考试题答案 本文档涵盖了Java编码规范的各种方面,包括集合类、线程、对称密码算法、异常处理、命名规范、随机数生成、压缩文件解压、安全编程规范、操作系统登录用户名...

    java规范java编码规范java编码规范java编码规范

    Java编程规范是软件开发中非常重要的一个组成部分,它旨在提高代码的可读性、可维护性和团队间的协作效率。华为技术有限公司的企业技术规范DKBA1040-2001.12...因此,每个Java开发者都应该重视并遵循类似的编码规范。

    JAVA编码规范试题

    JAVA编码规范是软件开发中不可或缺的一部分,它不仅有助于提高代码的可读性和可维护性,还能促进团队协作,减少潜在的编程错误。以下是从给定的文件信息中提炼出的关键知识点,涵盖了JAVA编码规范的基本原则、文件...

    百度java编码规范

    **百度Java编码规范** 在软件开发中,遵循一定的编码规范是非常重要的,它能提高代码的可读性,便于团队协作,降低维护成本。百度作为一家技术驱动的公司,也提出了其内部使用的Java编码规范,旨在确保代码的一致性...

    Java编码规范.doc

    Java编码规范是软件开发中非常重要的一个环节,它旨在提高代码质量、可读性、可维护性和团队协作效率。这份文档,"Java编码规范.doc",由东软集团有限公司的商用软件事业部编写,包含了国内大型Java项目和国际知名...

    阿里Java的编码规范

    Java、编码规范、Java编码规范、阿里巴巴、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里...

    Java编码规范(详细)

    Java编码规范是编程实践中至关重要的指导原则,它旨在提高代码的可读性、可维护性和团队协作效率。本文档详细阐述了Java编程时应遵循的一些关键规则和最佳实践。 1. **简介** - **目的**:制定这些规范的主要目的...

    Java 编码规范 chm

    1. **命名约定**:Java编码规范对变量、方法、类和包的命名有明确的要求。例如,类名应采用驼峰式命名法,每个单词首字母大写;方法名和变量名则使用小驼峰式,首个单词全小写;常量全大写,单词间用下划线分隔。包...

    java编码规范.zip

    本压缩包“java编码规范.zip”提供了华为版的编码规范和一个详细的Java代码规范版本,旨在帮助开发者遵循一致的规则,编写出易于阅读、维护的高质量代码。 首先,我们来看华为版的Java编码规范。华为作为全球知名的...

    JAVA编码规范全集

    ### JAVA编码规范全集 #### 1. 介绍 ##### 1.1 为什么要有编码规范 编码规范在软件开发过程中扮演着至关重要的角色。它不仅有助于提高代码的可读性和可维护性,还能增强团队协作效率。以下是几个关键理由: - **...

    公司java编码规范

    【公司Java编码规范】是确保团队协作和代码质量的重要文档,它定义了开发人员在编写Java代码时应遵循的一系列规则和最佳实践。这些规范旨在提高代码可读性、可维护性和可扩展性,减少错误,并使代码更容易理解和调试...

    Neusoft公司Java编码规范.rar

    Java编码规范(Java Coding Standard) oiNSFT-BS-OT0105 V3.0 2005-5-11 东软集团有限公司 商用软件事业部 版权所有 中国 沈阳浑南高新技术产业开发区 东软软件园

Global site tag (gtag.js) - Google Analytics