欢迎进入广州凡科互联网科技有限公司网站
全国服务热线
4000-399-000
Google 荣誉出品的 Java 编号标准,明显强烈推荐,
时间: 2021-02-14 16:46 浏览次数:
在线客服QQ: 联络电話: Email: freeteam这一份文本文档是 Google Java 程序编写设计风格标准的详细界定。当且仅当一个Java源代码合乎此篇档中的标准, 大家才觉得它合乎Google的Java程序编写设
在线客服QQ: 联络电話: Email: freeteam

这一份文本文档是 Google Java 程序编写设计风格标准的详细界定。当且仅当一个Java源代码合乎此篇档中的标准, 大家才觉得它合乎Google的Java程序编写设计风格。全文:google.github.io/ 译者:Hawstein /2014/01/20/google-java-style/

两者之间它的程序编写设计风格手册一样,这儿所探讨的不但仅是编号文件格式美不美观大方的难题, 同时也探讨一些承诺及编号规范。但是,这一份文本文档关键偏重于于大家所广泛遵照的标准, 针对这些并不是确立强制性规定的,大家尽可能防止出示建议。

在逆锋起笔手机微信微信公众号后台管理回应重要字:标准,可获得超清 PDF 版的免费下载详细地址《Google Java程序编写设计风格手册/标准》

假如你要获得阿里巴巴巴巴全新的《Java开发设计指南》,请关心逆锋起笔手机微信微信公众号,在后台管理回应重要字:java指南,既可获得。

1.1 专业术语表明

在文中档中,除非是另有表明:

1、专业术语class可表明一个一般类,枚举类型类,插口或者annotation种类( @interface)

ments),ments”一词,只是用Javadoc。

别的的专业术语表明会有时候在后边的文本文档出現。

1.2 手册表明

文中档中的实例编码其实不做为标准。换句话说,尽管实例编码是遵照Google程序编写设计风格,但其实不寓意着它是呈现这种编码的唯一方法。实例中的文件格式挑选不可该被强制性列入标准。

源代码基本 2.1 文档名

源代码以其最高层的类名来取名,尺寸写比较敏感,文档拓展名叫 .java。

2.2 文档编号:UTF-8

源代码编号文件格式为UTF-8。

2.3 独特标识符

2.3.1 空白页标识符

除开行完毕符编码序列,ASCII水准空格符标识符(0x20,即空格符)是源代码中唯一容许出現的空白页标识符,这寓意着:

1、全部其他标识符串中的空白页标识符必须开展转义。

2、制表符无需于缩近。

2.3.2 独特转义编码序列

针对具备独特转义编码序列的一切标识符(\b, \t, \n, \f, \r, ", '及),大家应用它的转义编码序列,而并不是相对的八进制(例如 \012)或Unicode(例如 \u000a)转义。

2.3.3 非ASCII标识符

针对剩下的非ASCII标识符,是应用具体的Unicode标识符(例如∞),還是应用等额的的Unicode转义符(例如\u221e),在于哪一个能让编码更加容易于阅读文章和了解。

Tip: 在应用Unicode转义符或者一些具体的Unicode标识符时,提议做些注解得出表述,这有利于于他人阅读文章和了解。

比如:

String
 unitAbbrev = 
;                                 | 赞,即便沒有注解也十分清楚
String
 unitAbbrev = 
"\u03bcs"
// "μs"                    | 容许,但沒有原因要那样做
String
 unitAbbrev = 
"\u03bcs"
// Greek letter mu, "s"    | 容许,但那样做看起来愚钝还非常容易错误
String
 unitAbbrev = 
"\u03bcs"
;                            | 很糟,阅读者压根看不出来它是甚么
return
'\ufeff'
 + content; 
// byte order mark             | Good,针对非复印标识符,应用转义,并在必需时写上注解

Tip: 始终不必因为担心一些程序将会没法恰当解决非ASCII标识符而给你的编码易读性变差。当程序没法恰当解决非ASCII标识符时,它当然没法恰当运作, 你也就想去fix这种难题的了。(言下之意便是胆大去用非ASCII标识符,假如确实有必须得话)

源代码构造

一个源代码包括(按序地):

1、批准证或著作权信息内容(若有必须)

2、package句子

3、import句子

4、一个顶尖类(仅有一个)

之上每一个一部分中间用一个空白行分隔。

3.1 批准证或著作权信息内容

假如一个文档包括批准证或著作权信息内容,那麼它理应被放到文档最前边。

3.2 package句子

package句子不换行,列限定(4.4节)其实不可用于package句子。(即package句子写在一行里)

3.3 import句子

3.3.1 import不必应用使用通配符

即,不必出現相近那样的import句子:importjava.util.*;

3.3.2 不必换行

import句子不换行,列限定(4.4节)其实不可用于import句子。(每一个import句子单独出行)

3.3.3 次序和间隔

import句子可分成下列两组,依照这一次序,每组由一个空白行隔开:

1、全部的静态数据导进单独组合

2、 com.google .google包下)

3、第三方的包。每一个顶尖包为一组,字典序。比如:android, com, junit, org, sun

4、 java imports

5、 javax imports

组内不空白行,按字典序排序。

微信公众号 逆锋起笔 潜心共享 Java、Python、前端开发、大厂工作经验、岗位发展趋势干货知识;每日中午 14:40 消息推送,每一个程序猿非常值得关心的技术性服务平台。关心即送网编梳理的经典视頻实例教程。

3.4 类申明

3.4.1 仅有一个顶尖类申明

每一个顶尖类都会一个与它同名的的源代码中(自然,还包括 .java后缀名)。

.java,类。

3.4.2 类组员次序

类的组员次序对易懂性有非常大的危害,但这都不存有唯一的通用性规律。不一样的类对组员的排列将会不是同的。最大要的一点,每一个类应当以某类逻辑性去排列它的组员,维护保养者应当要能表述这类排列逻辑性。

例如, 新的方式不可以一直习惯性性地加上到类的末尾,由于那样便是准时间次序并非某类逻辑性来排列的。

3.4.2.1 轻载:绝不分离出来 当一个类有好几个结构涵数,或者好几个同名的方式,这种涵数/方式应当按序出現在一起,正中间不必放入其他涵数/方式。

专业术语表明:块状构造(block-like construct)指的是一个类,方式或结构涵数的行为主体。必须留意的是,数字能量数组原始化中的原始值可被挑选性地视作块状构造(4.8.3.1节)。

4.1 大括弧

4.1.1 应用大括弧(即便是可选择的)

大括弧与 if,else,for,do,while句子一起应用,即便仅有一条句子(或者空),也应当把大括弧写上。

4.1.2 非空块:K R 设计风格

针对非空块和块状构造,大括弧遵照Kernighan和Ritchie设计风格 (Egyptian brackets):

1、左大括弧前不换行

2、左大括弧后换行

3、右大括弧前换行

4、假如右大括弧是一个句子、涵数体或类的停止,则右大括弧后换行; 不然不换行。比如,假如右大括弧后边是else或分号,则不换行。

实例:

return
MyClass
@Override
public
 method() {
 (condition()) {
      
        something();
      } 
catch
ProblemException
 e) {
        recover();
      }
    }

4.8.1节得出了enum类的一些列外。

4.1.3 空块:能够用简约版本号

一个空的块状构造里甚么都不包括,大括弧能够简约地写出 {},不用换行。列外:假如它是一个多块句子的一一部分(if/else 或 try/catch/finally) ,即便大括弧内没內容,右大括弧还要换行。

实例:

void
 doNothing() {}
4.2 块缩近:两个空格符

每每刚开始一个新的块,缩近提升两个空格符,当块完毕时,缩近回到此前的缩近级別。缩近级別可用于编码和注解。(见4.1.2节中的编码实例)

4.3 一行一个句子

每一个句子后应换行。

4.4 列限定:80或100

一个新项目能够挑选一行80字符或一百个标识符的列限定,除开以下列外,一切一行假如超出这一标识符数限定,务必全自动换行。

列外:

1、不能能考虑列限定的行(比如,Javadoc中的一个长URL,或者一个长的JSNI方式参照)。

2、 package和 import句子(见3.2节和3.3节)。

3、注解中这些将会被裁切并黏贴到shell中的指令行。

4.5 全自动换行

专业术语表明:一般状况下,一行长编码以便防止超过列限定(80或一百个标识符)而被分成几行,大家称作全自动换行(line-wrapping)。

大家并沒有全方位,明确性的规则来决策在每一种状况下怎样全自动换行。许多情况下,针对同一段编码会出现多种合理的全自动换行方法。

Tip: 获取方式或部分自变量能够不在换行的状况下处理编码太长的难题(是有效减少取名长短吧)

4.5.1 从哪儿断掉

全自动换行的基本原则是:更趋向于在高些的英语的语法级別处断掉。

1、假如在 非取值计算符处断掉,那麼在该标记前断掉(例如+,它将坐落于下一行)。留意:这一点与Google其他語言的程序编写设计风格不一样(如C++和JavaScript)。这条标准也可用于下列“类计算符”标记:点隔开符(.),种类界线中的 ( TextendsFoo Bar ),catch块中的管路标记( catch(FooException|BarExceptione)

2、假如在 取值计算符处断掉,一般的作法是在该标记后断掉(例如=,它与前边的內容留到同一行)。这条标准也可用于 foreach句子中的分号。

3、方式名或结构涵数名与左括弧留到同一行。

4、分号(,)两者之间前边的內容留到同一行。

4.5.2 全自动换行时缩近最少+4个空格符

全自动换行时,第一行后的每一行最少比第一行多缩近4个空格符(留意:制表符无需于缩近。见2.3.1节)。

当存有持续全自动换行时,缩近将会会多缩近不只4个空格符(英语的语法原素存有多级别时)。一般来讲,2个持续履行用同样的缩近当且仅当他们刚开始于平级英语的语法原素。

第四.6.3水准两端对齐一节中强调,不激励应用可变性数量的空格符来两端对齐前边行的标记。

4.6 空白页

4.6.1 竖直空白页

下列状况必须应用一个空白行:

1、类内持续的组员中间:字段名,结构涵数,方式,嵌套循环类,静态数据原始化块,案例原始化块。

比如:2个持续字段名中间的空白行是可选择的,用以字段名的空白行关键用于对字段名开展逻辑性排序。

2、在涵数身体,句子的逻辑性排序间应用空白行。

3、类内的第一个组员前或最终一个组员后的空白行是可选择的(既不激励都不抵制那样做,视本人爱好而定)。

4、要考虑文中档中别的节的空白行规定(例如3.3节:import句子)

好几个持续的空白行是容许的,但沒有必需那样做(大家都不激励那样做)。

4.6.2 水准空白页

除开語言要求和其他标准,而且除开文本,注解和Javadoc采用单独空格符,单独ASCII空格符也出現在下列好多个地区:

1、隔开一切保存字与紧跟之后的左括弧( ()(如 if,forcatch等)。

2、隔开一切保存字两者之间前边的右大括弧( })(如 else,catch)。

3、在一切左大括弧前( {),2个列外:

@SomeAnnotation({a,b})(不应用空格符)。String[][]x=foo;(大括弧间沒有空格符,见下边的Note)。

4、在一切二元或三元计算符的两边。这也可用于下列“类计算符”标记:

种类界线中的 ( TextendsFoo Bar )。catch块中的管路标记( catch(FooException|BarExceptione)。foreach句子中的分号。

5、在 ,:;及右括弧( ))后

6、假如在一条句子后做注解,则双斜杠(//)两侧必须空格符。这儿能够容许好几个空格符,但沒有必需。

7、种类和自变量中间:Listlist。

8、数字能量数组原始化中,大括弧内的空格符是可选择的,即 newint[]{5,6}和 newint[]{5,6}全是能够的。

Note:这一标准其实不规定或严禁一行的电源开关或末尾必须附加的空格符,只对里部空格符做规定。

4.6.3 水准两端对齐:不做规定

专业术语表明:水准两端对齐指的是根据提升可变性总数的空格符来使某一行的标识符与上一行的相对标识符两端对齐。

它是容许的(并且不在少地区能看到那样的编码),但Google程序编写设计风格对于此事不做规定。即便针对早已应用水准两端对齐的编码,大家都不必须去维持这类设计风格。

下列实例先展现未两端对齐的编码,随后是两端对齐的编码:

private
// this is fine
private
Color
 color; 
// this too
private
   x;      
// permitted, but future edits
private
Color
 color;  
// may leave it unaligned

Tip:两端对齐可提升编码易读性,但它为今后的维护保养产生难题。考虑到将来某一情况下,大家必须改动一堆两端对齐的编码中的一行。这将会造成本来很美的两端对齐编码越来越移位。极可能它会提醒你调节周边编码的空白页来使这一堆编码再次水准两端对齐(例如程序猿想维持这类水准两端对齐的设计风格), 这便会给你做很多的瞎忙,提升了reviewer的工作中而且将会造成大量的合拼矛盾。

4.7 用小括弧来限制组:强烈推荐

除非是创作者和reviewer都觉得除掉小括弧都不会使编码被误会,或者除掉小括弧能让编码更加容易于阅读文章,不然大家不可该除掉小括弧。大家沒有原因假定阅读者能记牢全部Java计算符优先选择级表。

微信公众号 逆锋起笔 潜心共享 Java、Python、前端开发、大厂工作经验、岗位发展趋势干货知识;每日中午 14:40 消息推送,每一个程序猿非常值得关心的技术性服务平台。关心即送网编梳理的经典视頻实例教程。

4.8 实际构造

4.8.1 枚举类型类

枚举类型变量定义间用分号分隔,换行可选择。

沒有方式和文本文档的枚举类型类可写出数字能量数组原始化的文件格式:

private enum  Suit
 { CLUBS, HEARTS, SPADES, DIAMONDS }

因为枚举类型类也是一个类,因而全部可用于其他类的文件格式标准也可用于枚举类型类。

4.8.2 自变量申明

4.8.2.1 每一次只申明一个自变量 不必应用组成申明,例如 inta,b;。

4.8.2.2 必须时才申明,并尽早开展原始化 不必在一个编码块的开始把部分自变量一次性都申明了(它是c語言的作法),只是在第一次必须应用它时才申明。部分自变量在申明时最好就开展原始化,或是申明后尽早开展原始化。

4.8.3 数字能量数组

4.8.3.1 数字能量数组原始化:可写出块状构造 数字能量数组原始化能够写出块状构造,例如,下边的书写全是OK的:

new int[] {0, 1, 2, 3}

new int[] {0,1,2,3}

new int[] {0, 1,2, 3}

new int[]{0, 1, 2, 3}

4.8.3.2 非C设计风格的数字能量数组申明 中括弧是种类的一一部分:String[]args, 并非 Stringargs[]。

4.8.4 switch句子

专业术语表明:switch块的大括弧内是一个或好几个句子组。每一个句子组包括一个或好几个switch标识( caseFOO:或 default:),后边跟随一条或好几条句子。

4.8.4.1 缩近 两者之间它块状构造一致,switch块中的內容缩近为两个空格符。

每一个switch标识后新起一行,再缩近两个空格符,写出一条或好几条句子。

4.8.4.2 Fall-through:注解

在一个switch块内,每一个句子组要不根据 break,continue,return或抛出去出现异常来停止,要不根据一条注解来讲明程序将再次实行到下一个句子组, 一切能表述这一含意的注解全是OK的(典型性的是用 // fall through)。这一独特的注解其实不必须在最终一个句子组(通常为 default)抽出现。实例:

switch
 (input) {
case 1:
case 2:
  prepareOneOrTwo();
// fall through
case 3:
   handleOneTwoOrThree();   
break;  
default:
    handleLargeNumber(input);

4.8.4.3 default的状况要写成来

每一个switch句子都包括一个 default句子组,即便它甚么编码都不包括。

4.8.5 注释(Annotations)

注释紧随在文本文档块后边,运用于类、方式和结构涵数,一个注释占有一行。这种换行不归属于全自动换行(第四.5节,全自动换行),因而缩近级別不会改变。比如:

@Override
@Nullable
public String getNameIfPresent() { ... }

列外:单独的注释能够和签字的第一行出現在同一行。比如:

@Override
 public  int hashCode() { ... }

运用于字段名的注释紧跟文本文档块出現,运用于字段名的好几个注释容许与字段名出現在同一行。比如:

@Partial
 @Mock
 DataLoader
 loader;

主要参数和部分自变量注释沒有特殊标准。

4.8.6 注解

4.8.6.1 块注解设计风格 块注解两者之间周边的编码在同一缩近级別。他们能够是 /* ... /设计风格,还可以是 // ...设计风格。针对几行的 / ... */注解,事后行务必从 *刚开始, 而且与前一行的 *两端对齐。下列实例注解全是OK的。

/*
 * This is          // And so           /* Or you can
 * okay.            // is this.          * even do this. */

注解不必封闭式在由星号或其他标识符绘图的架构里。

Tip:在写几行注解时,假如你期待在必需时能再次换行(即注解像文章段落设计风格一样),那麼应用 /* ... */。

4.8.7 Modifiers

类和组员的modifiers假如存有,则按Java語言标准中强烈推荐的次序出現。

public
protected
private
abstract
static
final
transient
volatile
synchronized
native
strictfp
5.1 对全部标志符都通用性的标准

标志符只有应用ASCII英文字母和数据,因而每一个合理的标志符名字都能配对正则表达式表述式 \w+。

在Google其他程序编写語言设计风格中应用的独特作为前缀或后缀名,如 name_, mName, s_name和 kName,在Java程序编写设计风格上都已不应用。

5.2 标志符种类的标准

5.2.1 包名

包名所有小写,持续的英语单词仅仅简易地联接起來,不应用下横线。

5.2.2 类名

类名都以 UpperCamelCase设计风格撰写。

类名一般是名词或名词语句,插口名字有时候将会是描述词或描述词语句。如今还没有有特殊的标准或切实可行的承诺来取名注释种类。

检测类的取名以它要检测的类的名字刚开始,以 Test完毕。比如, HashTest或 HashIntegrationTest。

5.2.3 方式名

方式名都以 lowerCamelCase设计风格撰写。

方式名一般是动词或动词语句。

下横线将会出現在JUnit检测方式名字选用以隔开名字的逻辑性部件。一个典型性的方式是:test_,比如 testPop_emptyStack。其实不存有唯一恰当的方法来取名检测方式。

5.2.4 变量定义名

变量定义名取名方式为 CONSTANT_CASE,所有英文字母英文大写,用下横线隔开英语单词。那,究竟甚么算作一个变量定义?

每一个变量定义全是一个静态数据final字段名,但并不是全部静态数据final字段名全是变量定义。在决策一个字段名是不是是一个变量定义时, 考虑到它是不是确实觉得好像一个变量定义。比如,假如一切一个该案例的观察情况是可变性的,则它基本上毫无疑问不容易是一个变量定义。仅仅始终不 准备更改目标通常为不足的,它要确实一直不会改变才可以将它示为变量定义。

这种姓名一般是名词或名词语句。

5.2.5 十分量字段名名

十分量字段名名以 lowerCamelCase设计风格撰写。

这种姓名一般是名词或名词语句。

5.2.6 主要参数名

主要参数名以 lowerCamelCase设计风格撰写。

主要参数应当防止用单独标识符取名。

5.2.7 部分自变量名

部分自变量名以 lowerCamelCase设计风格撰写,相比其他种类的名字,部分自变量名能够有更加比较宽松的简称。

尽管简称更比较宽松,但還是要防止用单标识符开展取名,除开临时性自变量和循环系统自变量。

即便部分自变量是final和不能更改的,都不应当把它示为变量定义,当然都不可用变量定义的标准去取名它。

5.2.8 种类自变量名

种类自变量能用下列二种设计风格之一开展取名:

1、单独的英文大写英文字母,后边能够跟一数量字(如:E, T, X, T2)。

2、以类取名方法(5.2.2节),后边加个英文大写的T(如:RequestT, FooBarT)。

5.3 驼峰式取名法(CamelCase)

驼峰式取名法分大驼峰式取名法( UpperCamelCase)和小驼峰式取名法( lowerCamelCase)。有时候,大家有不只一种有效的方法将一个英文短语变换成驼峰方式,如缩略语或不寻常的构造(比如”IPv6”或”iOS”)。Google特定了下列的变换计划方案。强烈推荐:道别狗屎编码,请记牢这 11 条编号窍门!

姓名从 短文方式(prose form)刚开始:

1、把语句变换为纯ASCII码,而且清除一切单引号。比如:”Müller’s algorithm”将变为”Muellers algorithm”。

2、把这一結果分割签单词,在空格符或其他标点(一般是连标识符)处罚划开。

强烈推荐:假如某一英语单词早已拥有常见的驼峰表明方式,按它的构成将它切分开(如”AdWords”将切分成”ad words”)。必须留意的是”iOS”其实不是一个真实的驼峰表明方式,因而该强烈推荐对它其实不可用。

3、如今将全部英文字母都小写(包含简称),随后将英语单词的第一个英文字母英文大写:每一个英语单词的第一个英文字母都英文大写,到来到大驼峰式取名。除开第一个英语单词,每一个英语单词的第一个英文字母都英文大写,到来到小驼峰式取名。

4、最终将全部的英语单词联接起來获得一个标志符。

实例:

加星号处表明能够,但不强烈推荐。

Note:在英文中,一些含有连标识符的英语单词方式不唯一。比如:”nonempty”和”non-empty”全是恰当的,因而方式名 checkNonempty和 checkNonEmpty也全是恰当的。

微信公众号 逆锋起笔 潜心共享 Java、Python、前端开发、大厂工作经验、岗位发展趋势干货知识;每日中午 14:40 消息推送,每一个程序猿非常值得关心的技术性服务平台。关心即送网编梳理的经典视頻实例教程。

6.1 @Override:可用则用

要是是合理合法的,就把 @Override注释给用上。

6.2 捕捉的出现异常:不可以忽略

除开下边的事例,对捕捉的出现异常不做响应是非常少恰当的。(典型性的响应方法是复印系统日志,或是假如它被觉得不是将会的,则把它作为一个 AssertionError再次抛出去。)

假如它的确不是必须在catch块中做一切响应,必须做注解多方面表明(以下面的事例)。

列外:在检测中,假如一个捕捉的出现异常被取名为 expected,则它能够被不用注解地忽视。下边是一种十分普遍的情况,用于保证所检测的方式会抛出去一个期待中的出现异常, 因而在这里里就沒有必需加注解。

6.3 静态数据组员:应用类开展启用

应用类名启用静态数据的类组员,而并不是实际某一目标或表述式。

6.4 Finalizers: 禁止使用

非常少想去重新写过 Object.finalize。

Tip:不必应用finalize。假如你非得应用它,请先细心阅读文章和了解Effective Java 第7条文:“Avoid Finalizers”,随后不必应用它。

Javadoc 7.1 文件格式

7.1.1 一般方式

Javadoc块的基本文件格式以下所显示:

/**
 * Multiple lines of Javadoc text are written here,
 * wrapped normally...
public
 method(
String
 p1) { ... }

或是是下列单行方式:

/** An especially short bit of Javadoc. */

基本文件格式一直OK的。当全部Javadoc块能容下于一行时(),可使用单行方式。

7.1.2 文章段落

空白行(即,只包括最左边星号的行)会出現在文章段落中间和Javadoc标识(@XXX)以前(假如有得话)。除开第一个文章段落,每一个文章段落第一个英语单词前都是有标识

,而且它和第一个英语单词间沒有空格符。

7.1.3 Javadoc标识

规范的Javadoc标识按下列次序出現:@param, @return, @throws, @deprecated, 前边这4种标识假如出現,叙述也不能为空。当叙述没法在一行中容下,持续行必须最少再缩近4个空格符。

7.2 引言片断

每一个类或组员的Javadoc以一个简洁明了的引言片断刚开始。这一片断是是非非常关键的,在一些状况下,它是唯一出現的文字,例如在类和方式数据库索引中。

这仅仅一个小片断,能够是一个名词语句或动词语句,但并不是一个详细的语句。它不容易以 A{@codeFoo}isa...或 Thismethod returns...开始, 它都不会是一个详细的祈使句,如 Savethe record...。但是,因为开始英文大写及被加了标点,它看上去如同是个详细的语句。

Tip:一个普遍的不正确是把简易的Javadoc写出 /** @return the customer ID /,它是歪斜确的。它应当写出 /* Returns the customer ID. */。

7.3 哪儿必须应用Javadoc

最少在每一个public类及它的每一个public和protected组员处应用Javadoc,下列是一些列外:

7.3.1 列外:不言自明的方式

针对简易显著的方式如 getFoo,Javadoc是可选择的(即,是能够不写的)。这类状况下除开写“Returns the foo”,的确都没有甚么非常值得写了。

模块检测类中的检测方式将会不是言自明的最经常见事例了,大家一般能够从这种方式的叙述性取名中了解它是做什么的,因而不用附加的文本文档表明。

Tip:假如有一些有关信息内容是必须阅读者掌握的,那麼之上的列外不可做为忽略这种信息内容的原因。比如,针对方式名 getCanonicalName, 也不应当忽略文本文档表明,由于阅读者极可能不知道道词句 canonical name指的是啥。

7.3.2 列外:重新写过

假如一个方式重新写过了超类中的方式,那麼Javadoc并不是必不可少的。

7.3.3 可选择的Javadoc

针对包外不能见的类和方式,若有必须,也是要应用Javadoc的。假如一个注解是用于界定一个类,方式,字段名的总体目地或个人行为, 那麼这一注解应当写出Javadoc,那样更统一更友善。

在逆锋起笔手机微信微信公众号后台管理回应重要字:标准,可获得超清 PDF 版的免费下载详细地址《Google Java程序编写设计风格手册/标准》

假如你要获得阿里巴巴巴巴全新的《Java开发设计指南》,请关心逆锋起笔手机微信微信公众号,在后台管理回应重要字:java指南,既可获得。

微信公众号 逆锋起笔 潜心共享 Java、Python、前端开发、大厂工作经验、岗位发展趋势干货知识;每日中午 14:40 消息推送,每一个程序猿非常值得关心的技术性服务平台。关心即送网编梳理的经典视頻实例教程。



Copyright © 广州凡科互联网科技有限公司 版权所有 粤ICP备10235580号
全国服务电话:4000-399-000   传真:021-45545458
公司地址:广州市海珠区工业大道北67号凤凰创意园