Google Java编程风格指南

Google Java编程风格指南

ID:32314403

大小:427.46 KB

页数:12页

时间:2019-02-03

Google Java编程风格指南_第1页
Google Java编程风格指南_第2页
Google Java编程风格指南_第3页
Google Java编程风格指南_第4页
Google Java编程风格指南_第5页
资源描述:

《Google Java编程风格指南》由会员上传分享,免费在线阅读,更多相关内容在学术论文-天天文库

1、Hawstein'sBlogHomeArchiveCategoriesSitemapAboutSubscribeGoogleJava编程风格指南January20,2014作者:Hawstein出处:http://hawstein.com/posts/google-java-style.html声明:本文采用以下协议进行授权:自由转载-非商用-非衍生-保持署名

2、CreativeCommonsBY-NC-ND3.0,转载请注明作者及出处。目录1.前言2.源文件基础3.源文件结构4.格式5.命名约定6.编程实践7.Javadoc8.后记前

3、言这份文档是GoogleJava编程风格规范的完整定义。当且仅当一个Java源文件符合此文档中的规则,我们才认为它符合Google的Java编程风格。与其它的编程风格指南一样,这里所讨论的不仅仅是编码格式美不美观的问题,同时也讨论一些约定及编码标准。然而,这份文档主要侧重于我们所普遍遵循的规则,对于那些不是明确强制要求的,我们尽量避免提供意见。1.1术语说明在本文档中,除非另有说明:1.术语class可表示一个普通类,枚举类,接口或是annotation类型(@interface)2.术语comment只用来指代实现的注释(imple

4、mentationcomments),我们不使用“documentationcomments”一词,而是用Javadoc。其他的术语说明会偶尔在后面的文档出现。1.2指南说明本文档中的示例代码并不作为规范。也就是说,虽然示例代码是遵循Google编程风格,但并不意味着这是展现这些代码的唯一方式。示例中的格式选择不应该被强制定为规则。源文件基础2.1文件名源文件以其最顶层的类名来命名,大小写敏感,文件扩展名为.java。2.2文件编码:UTF-8源文件编码格式为UTF-8。2.3特殊字符2.3.1空白字符除了行结束符序列,ASCII水平

5、空格字符(0x20,即空格)是源文件中唯一允许出现的空白字符,这意味着:1.所有其它字符串中的空白字符都要进行转义。2.制表符不用于缩进。2.3.2特殊转义序列对于具有特殊转义序列的任何字符(b,t,,f,r,“,‘及),我们使用它的转义序列,而不是相应的八进制(比如12)或Unicode(比如u000a)转义。2.3.3非ASCII字符对于剩余的非ASCII字符,是使用实际的Unicode字符(比如∞),还是使用等价的Unicode转义符(比如u221e),取决于哪个能让代码更易于阅读和理解。Tip:在使用

6、Unicode转义符或是一些实际的Unicode字符时,建议做些注释给出解释,这有助于别人阅读和理解。例如:StringunitAbbrev="μs";

7、赞,即使没有注释也非常清晰StringunitAbbrev="u03bcs";//"μs"

8、允许,但没有理由要这样做StringunitAbbrev="u03bcs";//Greeklettermu,"s"

9、允许,但这样做显得笨拙还容易出错StringunitAbbrev="u03bcs";

10、很糟,读者根本看不出这是什么return'ufeff'+content;//byte

11、ordermark

12、Good,对于非打印字符,使用转义,并在必要时写上注释Tip:永远不要由于害怕某些程序可能无法正确处理非ASCII字符而让你的代码可读性变差。当程序无法正确处理非ASCII字符时,它自然无法正确运行,你就会去fix这些问题的了。(言下之意就是大胆去用非ASCII字符,如果真的有需要的话)源文件结构一个源文件包含(按顺序地):1.许可证或版权信息(如有需要)2.package语句3.import语句4.一个顶级类(只有一个)以上每个部分之间用一个空行隔开。3.1许可证或版权信息如果一个文件包含许可证或版权信息,那么它

13、应当被放在文件最前面。3.2package语句package语句不换行,列限制(4.4节)并不适用于package语句。(即package语句写在一行里)3.3import语句3.3.1import不要使用通配符即,不要出现类似这样的import语句:importjava.util.*;3.3.2不要换行import语句不换行,列限制(4.4节)并不适用于import语句。(每个import语句独立成行)3.3.3顺序和间距import语句可分为以下几组,按照这个顺序,每组由一个空行分隔:1.所有的静态导入独立成组2.com.goog

14、leimports(仅当这个源文件是在com.google包下)3.第三方的包。每个顶级包为一组,字典序。例如:android,com,junit,org,sun4.javaimports5.javaximports组内

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。