您好、欢迎来到现金彩票网!
当前位置:彩70 > 符号编码 >

Google 出品的 Java 编码规范和编程指南权威又科学强烈推荐

发布时间:2019-04-24 20:30 来源:未知 编辑:admin

  原标题:Google 出品的 Java 编码规范和编程指南,权威又科学,强烈推荐

  这份文档是Google Java编程风格规范的完整定义。当且仅当一个Java源文件符合此文档中的规则, 我们才认为它符合Google的Java编程风格。

  与其它的编程风格指南一样,这里所讨论的不仅仅是编码格式美不美观的问题, 同时也讨论一些约定及编码标准。然而,这份文档主要侧重于我们所普遍遵循的规则, 对于那些不是明确强制要求的,我们尽量避免提供意见。

  本文档中的示例代码并不作为规范。也就是说,虽然示例代码是遵循Google编程风格,但并不意味着这是展现这些代码的唯一方式。示例中的格式选择不应该被强制定为规则。

  除了行结束符序列,ASCII水平空格字符(0x20,即空格)是源文件中唯一允许出现的空白字符,这意味着:

  对于具有特殊转义序列的任何字符(, , , , , , 及),我们使用它的转义序列,而不是相应的八进制(比如 )或Unicode(比如 )转义。

  对于剩余的非ASCII字符,是使用实际的Unicode字符(比如∞),还是使用等价的Unicode转义符(比如∞),取决于哪个能让代码更易于阅读和理解。

  Tip: 在使用Unicode转义符或是一些实际的Unicode字符时,建议做些注释给出解释,这有助于别人阅读和理解。

  Tip:永远不要由于害怕某些程序可能无法正确处理非ASCII字符而让你的代码可读性变差。当程序无法正确处理非ASCII字符时,它自然无法正确运行, 你就会去fix这些问题的了。(言下之意就是大胆去用非ASCII字符,如果真的有需要的话)

  1、许可证或版权信息(如有需要)2、package语句3、import语句4、一个顶级类(只有一个)

  import语句不换行,列限制(4.4节)并不适用于import语句。(每个import语句独立成行)

  类的成员顺序对易学性有很大的影响,但这也不存在唯一的通用法则。不同的类对成员的排序可能是不同的。最重要的一点,每个类应该以某种逻辑去排序它的成员,维护者应该要能解释这种排序逻辑。比如, 新的方法不能总是习惯性地添加到类的结尾,因为这样就是按时间顺序而非某种逻辑来排序的。

  当一个类有多个构造函数,或是多个同名方法,这些函数/方法应该按顺序出现在一起,中间不要放进其它函数/方法。

  术语说明:块状结构(block-like construct)指的是一个类,方法或构造函数的主体。需要注意的是,数组初始化中的初始值可被选择性地视为块状结构(4.8.3.1节)。

  大括号与if,else,for,do,while语句一起使用,即使只有一条语句(或是空),也应该把大括号写上。

  1、左大括号前不换行2、左大括号后换行3、右大括号前换行4、如果右大括号是一个语句、函数体或类的终止,则右大括号后换行; 否则不换行。例如,如果右大括号后面是else或逗号,则不换行。

  一个空的块状结构里什么也不包含,大括号可以简洁地写成{},不需要换行。例外:如果它是一个多块语句的一部分(if/else 或 try/catch/finally) ,即使大括号内没内容,右大括号也要换行。

  每当开始一个新的块,缩进增加2个空格,当块结束时,缩进返回先前的缩进级别。缩进级别适用于代码和注释。(见4.1.2节中的代码示例)

  一个项目可以选择一行80个字符或100个字符的列限制,除了下述例外,任何一行如果超过这个字符数限制,必须自动换行。

  1、不可能满足列限制的行(例如,Javadoc中的一个长URL,或是一个长的JSNI方法参考)。

  术语说明:一般情况下,一行长代码为了避免超出列限制(80或100个字符)而被分为多行,我们称之为自动换行(line-wrapping)。

  我们并没有全面,确定性的准则来决定在每一种情况下如何自动换行。很多时候,对于同一段代码会有好几种有效的自动换行方式。

  Tip: 提取方法或局部变量可以在不换行的情况下解决代码过长的问题(是合理缩短命名长度吧)

  1、如果在非赋值运算符处断开,那么在该符号前断开(比如+,它将位于下一行)。注意:这一点与Google其它语言的编程风格不同(如C++和Java)。这条规则也适用于以下“类运算符”符号:点分隔符(.),类型界限中的&(TextendsFoo&Bar),catch块中的管道符号(catch(FooExceptionBarExceptione)

  2、如果在赋值运算符处断开,通常的做法是在该符号后断开(比如=,它与前面的内容留在同一行)。这条规则也适用于foreach语句中的分号。

  自动换行时,第一行后的每一行至少比第一行多缩进4个空格(注意:制表符不用于缩进。见2.3.1节)。

  当存在连续自动换行时,缩进可能会多缩进不只4个空格(语法元素存在多级时)。一般而言,两个连续行使用相同的缩进当且仅当它们开始于同级语法元素。

  第4.6.3水平对齐一节中指出,不鼓励使用可变数目的空格来对齐前面行的符号。

  1、类内连续的成员之间:字段,构造函数,方法,嵌套类,静态初始化块,实例初始化块。

  例如:两个连续字段之间的空行是可选的,用于字段的空行主要用来对字段进行逻辑分组。

  3、类内的第一个成员前或最后一个成员后的空行是可选的(既不鼓励也不反对这样做,视个人喜好而定)。

  除了语言需求和其它规则,并且除了文字,注释和Javadoc用到单个空格,单个ASCII空格也出现在以下几个地方:

  1、分隔任何保留字与紧随其后的左括号(()(如if,forcatch等)。

  6、如果在一条语句后做注释,则双斜杠(//)两边都要空格。这里可以允许多个空格,但没有必要。

  8、数组初始化中,大括号内的空格是可选的,即newint[]{5,6}和newint[]{5,6}都是可以的。

  Note:这个规则并不要求或禁止一行的开关或结尾需要额外的空格,只对内部空格做要求。

  术语说明:水平对齐指的是通过增加可变数量的空格来使某一行的字符与上一行的相应字符对齐。

  这是允许的(而且在不少地方可以看到这样的代码),但Google编程风格对此不做要求。即使对于已经使用水平对齐的代码,我们也不需要去保持这种风格。

  Tip:对齐可增加代码可读性,但它为日后的维护带来问题。考虑未来某个时候,我们需要修改一堆对齐的代码中的一行。这可能导致原本很漂亮的对齐代码变得错位。很可能它会提示你调整周围代码的空白来使这一堆代码重新水平对齐(比如程序员想保持这种水平对齐的风格), 这就会让你做许多的无用功,增加了reviewer的工作并且可能导致更多的合并冲突。

  除非作者和reviewer都认为去掉小括号也不会使代码被误解,或是去掉小括号能让代码更易于阅读,否则我们不应该去掉小括号。我们没有理由假设读者能记住整个Java运算符优先级表。

  不要在一个代码块的开头把局部变量一次性都声明了(这是c语言的做法),而是在第一次需要使用它时才声明。局部变量在声明时最好就进行初始化,或者声明后尽快进行初始化。

  术语说明:switch块的大括号内是一个或多个语句组。每个语句组包含一个或多个switch标签(caseFOO:或default:),后面跟着一条或多条语句。

  在一个switch块内,每个语句组要么通过break,continue,return或抛出异常来终止,要么通过一条注释来说明程序将继续执行到下一个语句组, 任何能表达这个意思的注释都是OK的(典型的是用// fall through)。这个特殊的注释并不需要在最后一个语句组(一般是default)中出现。示例:

  每个switch语句都包含一个default语句组,即使它什么代码也不包含。

  注解紧跟在文档块后面,应用于类、方法和构造函数,一个注解独占一行。这些换行不属于自动换行(第4.5节,自动换行),因此缩进级别不变。例如:

  应用于字段的注解紧随文档块出现,应用于字段的多个注解允许与字段出现在同一行。例如:

  块注释与其周围的代码在同一缩进级别。它们可以是/* ... */风格,也可以是// ...风格。对于多行的/* ... */注释,后续行必须从*开始, 并且与前一行的*对齐。以下示例注释都是OK的。

  Tip:在写多行注释时,如果你希望在必要时能重新换行(即注释像段落风格一样),那么使用/* ... */。

  类和成员的modifiers如果存在,则按Java语言规范中推荐的顺序出现。

  标识符只能使用ASCII字母和数字,因此每个有效的标识符名称都能匹配正则表达式w+。

  在Google其它编程语言风格中使用的特殊前缀或后缀,如name_,mName,s_name和kName,在Java编程风格中都不再使用。

  风格编写。类名通常是名词或名词短语,接口名称有时可能是形容词或形容词短语。

  ,全部字母大写,用下划线分隔单词。那,到底什么算是一个常量?每个常量都是一个静态final字段,但不是所有静态final字段都是常量。

  例如,如果任何一个该实例的观测状态是可变的,则它几乎肯定不会是一个常量。只是永远不打算改变对象一般是不够的,它要真的一直不变才能将它示为常量。// Constants

  风格编写,比起其它类型的名称,局部变量名可以有更为宽松的缩写。虽然缩写更宽松,但还是要避免用单字符进行命名,除了临时变量和循环变量。

  即使局部变量是final和不可改变的,也不应该把它示为常量,自然也不能用常量的规则去命名它。

  )和小驼峰式命名法(lowerCamelCase)。有时,我们有不只一种合理的方式将一个英语词组转换成驼峰形式,如缩略语或不寻常的结构(例如”IPv6”或”iOS”)。Google指定了以下的转换方案。名字从

  (prose form)开始:1、把短语转换为纯ASCII码,并且移除任何单引号。

  ”Müller’s algorithm”将变成”Muellers algorithm”。2、把这个结果切分成单词,在空格或其它标点符号(通常是连字符)处分割开。

  需要注意的是”iOS”并不是一个真正的驼峰表示形式,因此该推荐对它并不适用。3、现在将所有字母都小写(包括缩写),然后将单词的第一个字母大写:

  除了第一个单词,每个单词的第一个字母都大写,来得到小驼峰式命名。4、最后将所有的单词连接起来得到一个标识符。

  Asserti重新抛出。)如果它确实是不需要在catch块中做任何响应,需要做注释加以说明(如下面的例子)。

  在测试中,如果一个捕获的异常被命名为expected,则它可以被不加注释地忽略。下面是一种非常常见的情形,用以确保所测试的方法会抛出一个期望中的异常, 因此在这里就没有必要加注释。try {

  如果你非要使用它,请先仔细阅读和理解Effective Java 第7条款:“Avoid Finalizers”,然后不要使用它。

  空行(即,只包含最左侧星号的行)会出现在段落之间和Javadoc标记(@XXX)之前(如果有的话)。

  ,@return,@throws,@deprecated, 前面这4种标记如果出现,描述都不能为空。当描述无法在一行中容纳,连续行需要至少再缩进4个空格。7.2 摘要片段

  ,Javadoc是可选的(即,是可以不写的)。这种情况下除了写“Returns the foo”,确实也没有什么值得写了。单元测试类中的测试方法可能是不言自明的最常见例子了,我们通常可以从这些方法的描述性命名中知道它是干什么的,因此不需要额外的文档说明。

  例如,对于方法名getCanonicalName, 就不应该忽视文档说明,因为读者很可能不知道词语canonical name指的是什么。7.3.2 例外:

  声明:该文观点仅代表作者本人,搜狐号系信息发布平台,搜狐仅提供信息存储空间服务。

http://hayleylord.com/fuhaobianma/26.html
锟斤拷锟斤拷锟斤拷QQ微锟斤拷锟斤拷锟斤拷锟斤拷锟斤拷锟斤拷微锟斤拷
关于我们|联系我们|版权声明|网站地图|
Copyright © 2002-2019 现金彩票 版权所有