首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

Google Java编程风格规范(2020年4月原版翻译)

4.1 大括号 4.1.1 使用括号(即使是可选的) 大括号与if, else, for, do, while语句一起使用,即使只有一条语句(或是空),也应该把大括号写上。...很多时候,对于同一段代码会有好几种有效的自动换行方式。 注意(Note): 虽然换行的典型原因是为了避免溢出列限制,但即使是实际上符合列限制的代码也可能由作者自行决定是否进行行换行。...方法名或构造函数名与左括号留在同一。 逗号(,)与其前面的内容留在同一。...分隔任何保留字与其前面的右大括号(})(else, catch)。 在任何左大括号前({),两个例外: @SomeAnnotation({a, b})(不使用空格)。...4.8.6 注释 4.8.6.1 块注释风格 块注释与其周围的代码在同一缩进级别。它们可以是/* ... */风格,也可以是// ...风格。对于多行的/* ...

1.1K20

Google Java编程风格指南

4.1 大括号 4.1.1 使用括号(即使是可选的) 大括号一般用在if, else, for, do, while等语句,即使只有一条语句(或是空),也应该把大括号写上。...(例如:=,它与前面的内容留在同一)。 这条规则也适用于foreach语句中的冒号。 方法名或构造函数名与左括号留在同一。 逗号(,)与其前面的内容留在同一。也就是在逗号之后断行。...4.6.2 水平空白 除了语法、其他规则、词语分隔、注释和javadoc外,水平的ASCII空格只在以下情况出现: 所有保留的关键字与紧接它之后的位于同一的左大括号之间需要用空格隔开。...0 : a) 逗号(,)、冒号(:)、分号(;)和右小括号())、Lambda箭头符号(->)之后,需要空格隔开。 //双斜线开始一注释时,双斜线两边都应该用空格隔开。并且可使用多个空格。...则它可以和类或方法名放在同一。例如: @Override public int hashCode() { ... } 注解应用到成员变量时,也是紧接Javadoc之后。

97320
您找到你想要的搜索结果了吗?
是的
没有找到

Google Java 编程风格指南

4.1 大括号 4.1.1 使用括号(即使是可选的) 大括号与 if,else,for,do,while语句一起使用,即使只有一条语句(或是空),也应该把大括号写上。...方法名或构造函数名与左括号留在同一。 逗号(,)与其前面的内容留在同一。 4.5.2 自动换行时缩进至少+4个空格 自动换行时,第一后的每一至少比第一多缩进4个空格(注意:制表符不用于缩进。...4.6.2 水平空白 除了语言需求和其它规则,并且除了文字,注释和Javadoc用到单个空格,单个ASCII空格也出现在以下几个地方: 分隔任何保留字与紧随其后的左括号( ()( if,forcatch...分隔任何保留字与其前面的右大括号( })( else,catch)。 在任何左大括号前( {),两个例外: - @SomeAnnotation({a,b})(不使用空格)。...7.3.3 可选的Javadoc 对于包外不可见的类和方法,如有需要,也是使用Javadoc的。

1K11

Java后端开发规范(基于阿里开发规范)

三、代码格式 【强制】大括号使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果 是非空代码块则: 1) 左大括号前不换行。 2) 左大括号后换行。 3) 右大括号前换行。...【强制】在 if/else/for/while/do 语句中必须使用括号。...【强制】所有的类都必须添加创建者和创建日期。 【强制】方法内部单行注释,在被注释语句上方另起一使用//注释。方法内部多行注释 使用/* */注释,注意与代码对齐。...完全没有注释的大段代码对于阅读者形同 天书,注释是给自己看的,即使隔很长时间,也能清晰理解当时的思路;注释也是给继任者看 的,使其能够快速接替自己的工作。...---- 索引规约 【强制】业务上具有唯一特性的字段,即使是多个字段的组合,也必须建成唯一索引。

62021

Java编程规范-文件组织与排版

1缩进 不强制按照此规范改造 代码块要采用缩进风格编写, 缩进采用 4 个空格 , 不允许使用 Tab 缩进 。...; 3、如果右大括号是一个语句、函数体或类的终止,则在右大括号后换行,否则不换行; 4、如果大括号中没有语句,且右大括号后也没有语句时,则右大括号前不换行,与左大括号处于同一; 示例: 【正确用法...下列位置应该使用空格以使代码结构清晰,提高代码可读性: 1、左大括号前; 2、如果右大括号后面有语句,右大括号与后面语句之间; 3、关键字 (if 、 for 、 while 、 switch...‘(’ 之间 不需要 空格; 9、小括号与内部字符之间 不需要 空格; 10、没有必要 增加若干空格来使某一的字符与上一对应位置的字符对齐。...11、多行注释中,换行后星号 ‘’ 之前至少放置一个空格,为实现与首注释的星号 '’ 对齐; 12、注释星号 ‘*’ 与注释内容 如果处于同一,两者 之间放置一个空格; 13、注释的双斜线与注释内容之间有且仅有一个空格

60330

Java 编程风格军规,看这一篇就够了

4.1 大括号 4.1.1 使用括号(即使是可选的) 大括号与 if,else,for,do,while语句一起使用,即使只有一条语句(或是空),也应该把大括号写上。...方法名或构造函数名与左括号留在同一。 逗号(,)与其前面的内容留在同一。 4.5.2 自动换行时缩进至少+4个空格 自动换行时,第一后的每一至少比第一多缩进4个空格(注意:制表符不用于缩进。...4.6.2 水平空白 除了语言需求和其它规则,并且除了文字,注释和Javadoc用到单个空格,单个ASCII空格也出现在以下几个地方: 分隔任何保留字与紧随其后的左括号( ()( if,forcatch...分隔任何保留字与其前面的右大括号( })( else,catch)。 在任何左大括号前( {),两个例外: - @SomeAnnotation({a,b})(不使用空格)。...7.3.3 可选的Javadoc 对于包外不可见的类和方法,如有需要,也是使用Javadoc的。

93640

Google 出品的 Java 编码规范,强烈推荐,权威又科学!

4.1 大括号 4.1.1 使用括号(即使是可选的) 大括号与 if,else,for,do,while语句一起使用,即使只有一条语句(或是空),也应该把大括号写上。...3、方法名或构造函数名与左括号留在同一。 4、逗号(,)与其前面的内容留在同一。...2、分隔任何保留字与其前面的右大括号( })( else,catch)。 3、在任何左大括号前( {),两个例外: @SomeAnnotation({a,b})(不使用空格)。...4.8.6 注释 4.8.6.1 块注释风格 块注释与其周围的代码在同一缩进级别。它们可以是 /* ... */风格,也可以是 // ...风格。对于多行的 /* ......7.3.3 可选的Javadoc 对于包外不可见的类和方法,如有需要,也是使用Javadoc的。

2.6K40

Swift开发规范-修订版

】类、函数左大括号不另起一,与名称之间留有空格; 【强制】代码中的空格出现地点 注释符号与注释内容之间有空格; 类继承,参数名和类型之间等,冒号前面不加空格,但后面跟空格; 任何运算符前后有空格; 表示返回值的...-> 两边; 参数列表、数组、元祖、字典里的逗号后面有一个空格; 【强制】禁止使用无用分号; 【强制】方法之间空一; 【强制】重载的声明放在一起,按照参数的多少从少到多向下排列; 【强制】每一只声明一个常...【推荐】类似注解的修饰词单独占一@objc,@discardableResult 等; 五、注释规约 【强制】文档(API)注释使用单行注释,即///,不使用多行注释,即/** */。...⌥ ⌘ /自动生成文档模板; 【强制】将注释放在代码上一,而不是放在代码后;说明:放在代码后有两个弊端,一是当代码稍微长一点后,注释可能需要横向滚动后才能看全;另一个弊端是,当代码修改,极易将注释删除...【推荐】在代码中灵活的使用一些地标注释MARK、FIXME、TODO,当同一文件中存在多种类型定义或者多种逻辑时,可以使用Mark进行分组注释,方便通过Xcode顶部面包屑进行切换; 代码示例: /

1.7K50

Python学习笔记:PEP8常用编程规

,这些换行的元素应该使用更多的缩进来区分下面的缩进 4.换行:代码换行时应该优先使用括号、方括号和花括号中的隐式续,视情况使用反斜杠\来进行换行 5.二元运算符:在二元云算法的换行时推荐以二元运算符作为新的开始...6.多条语句同行:即使是简单的语句,即使可以使用分号,但是不推荐写在同一,比如再简单的if/for/while语句也应该分行写 二、空行 1.顶级定义:顶级函数和类定义的前后使用两个空行隔开 2.类方法...,在全局变量和常量定义之前 5.导入顺序:导入顺序应该是标准库,三方库,以及本地模块,且需要加空行分隔 6.导入路径:导入应该尽量使用绝对路径,或使用显式的相对路径也是可行的(:from . import...,视情况甚至可以删掉注释也不留错误的注释 2.注释使用一个#和一个空格开始,并且与注释的代码具有相同缩进,如果需要使用注释写多段意思的注释,可以使用一个空行注释(即这一只有一个#)来分隔不同意思的段落...3.代码之后的注释:应该与前面的代码间隔至少两个空格,然后也是使用一个#和一个空格开始,但是这种注释应该尽量少用,不必要的话就不用 4.文档注释:应该为所有公共的模块、函数、类和方法编写文档注释

83810

Python入门(5)

使用括号还有一个额外的优点:它能帮助我们改变运算的顺序。 例如:2*(3+4) PS:请适度使用括号,像这样(2 + (3 * 4))冗余的括号,就显得比较蠢了!...不过,因为python允许同一写入多条语句,而需要在每条语句之间加上分号作为分隔符,所以,如果你习惯在代码的结尾加上分号,python也不会报错。...在代码的开头留下空格,用以确定不同代码的逻辑关系,也是一种语句的分组方式。这意味着,同一个逻辑层次的代码语句必须拥有相同的缩进。每一组这样的语句被称为代码块(block)。...请确保你在缩进中使用数量一致的空格,否则你的程序将不能正常运行,或引发不期望的错误。 PS:Python 将始终对块使用缩进,并且绝不会使用括号。...接下来,我们将看到如何在程序中使用它们。

54630

JAVA 初学者的编码规范一:命名风格与代码格式

但是事实上并不是如此!因为一个人的编码规范是从开始学的时候就必须要练习和养成习惯的!从编码过程中的每一件小事做起!从我们初学的时候的 变量、 方法名、 类名等做起!不要看不起这一段代码!...其实大牛与小白写代码,除了思维上的差距外,其编码风格也是重中之重!可能两个人写相同的一段逻辑!小白写的,别人可能要花上10分钟去读取,而大牛写的代码可能只需要一分钟!其中差距就这么大!...例如 UserVO 方法名、参数名、成员变量、局部变量都统一使用首字母小写的驼峰命名法!列: lowerCamelCase 风格,必须遵循驼峰形式! 常量命名全大写!...注释的双斜线与注释内容之间有且只有一个空格 在进行强制类型转换时,右括号强制转换值之间不需要任何空格隔开! 单行字符严禁超过120个以上,超出换行!...遵循下方规范: 第二与第一缩进4个字符,从第三开始不再缩进 运算符与下文一起换行 方法调用与下文一起换行 方法调用中的多个参数需要换行时,在逗号后进行 在括号前不要进行换行 9.

68230

Go 程序的基本结构和要素

你必须在源文件中非注释的第一指明这个文件属于哪个包,:package main。package main表示一个可独立执行的程序,每个 Go 应用程序都包含一个名为 main 的包。...一个应用程序可以包含不同的包,而且即使你只使用 main 包也不必把所有的代码都写在一个巨大的文件里:你可以用一些较小的文件,并且在每个文件非注释的第一使用 package main 来指明这些文件都属于...左大括号 { 必须与方法的声明放在同一,这是编译器的强制规定,否则你在使用 gofmt 时就会出现错误提示: build-error: syntax error: unexpected semicolon...,因此才会引发像上面这样的错误 右大括号 } 需要被放在紧接着函数体的下一。...如果你的函数非常简短,你也可以将它们放在同一: func Sum(a, b int) int { return a + b } 对于大括号 {} 的使用规则在任何时候都是相同的(:if 语句等)。

834110

全面解读curl团队的C语言代码规范

命名 缩进 注释括号 'else' 在下一 括号前不加空格 使用布尔条件 条件中不要赋值 新块在新上 运算符周围加空格 返回值不加括号 sizeof 参数加括号 列对齐 平台相关代码 不要...只使用 **/* 注释 */**。...大括号 在 if/while/do/for 表达式中,我们将开放大括号写在与关键字同一,然后将闭合大括号设置在与初始关键字相同缩进级别的同一。...就像这样: while(1) { /* 永远循环 */ } 使用布尔条件 在 if/while 条件中,我们更喜欢测试条件值,布尔值与 TRUE 或 FALSE、指针与 NULL 或 !...ptr) return NULL; 新块在新上 永远不会在同一上写多个语句,即使是短的 if() 条件也不例外。

10310

赶上年底最后一趟末班车——Python编程基础之小白入门

单行注释:在需注释语句前加“#”,可在代码后使用,也可另起一使用 i=1 #在代码后使用注释 #另起一使用注释 ''' 使用单引号的多行注释 使用单引号的多行注释 ''' """ 使用双引号的多行注释...多行语句 python中默认以结束作为代码结束的标记,而有时候为了阅读方便,我们需要将一个完整代码跨行表示,这时候我们可以使用符:反斜杠“\”来将一语句分为多行显示: score = eng_score...+ \ math_score + \ his_score 注意:若语句中使用括号{}、中括号[]或小括号()将数据括起来,则不需要使用符,如下所示: name=[...) 变量的赋值 • 基本赋值 在python中,我们使用“=”对变量进行赋值,“x=3"。...• 多重赋值 对同一对象可以引用多个变量,例如一个人可以有多重身份,Mr Li 是一位父亲,同时也是一位教师,不同的变量,实质指向的对象是同一事物。

60510

Python和JavaScript在使用上有什么区别?

当一系列连续的代码行在同一级别缩进时,它们被视为同一代码块的一部分。 我们使用它来定义Python中的条件、函数、循环和所有的复合语句。 以下是示例: ?...在Python中使用缩进定义代码块 JavaScript如何定义代码块 在JavaScript中,我们使用括号({})将属于同一代码块的语句分组。 以下是示例: ?...让我们看看在Python和JavaScript中的注释分别是什么样的吧: 单行注释 在Python中,我们使用井号(#)编写注释。该符号之后同一上的所有字符均被视为注释的一部分。...在JavaScript中,我们写两个斜杠(//)来开始单行注释。 ? 多行注释 在Python中,要编写多行注释,我们要对每一程序前都加上#号,以标识这行为注释。...在条件之后,我们写一个冒号(:),代码缩进下一。 在JavaScript中,我们编写关键字Else if,后跟条件(用圆括号括起来)。条件结束后,我们编写花括号,并在花括号中缩进代码。 ?

4.8K20

阿里巴巴Java开发手册(华山版)

说明: 子类、父类成员变量名相同,即使是 public 类型的变量也是能够通过编译,而局部变量在同一方法 内的不同代码块中同名也是合法的,但是要避免使用。...(“ok”); // 在右大括号后直接结束,则必须换行 } } 【强制注释的双斜线与注释内容之间有且仅有一个空格。...【推荐】 单个方法的总行数不超过 80 。 说明: 除注释之外的方法签名、 左右大括号、方法内代码、空行、回车及任何不可见字符的总行数不超过 80 。...【强制】 在 if/else/for/while/do 语句中必须使用括号。 说明: 即使只有一代码,避免采用单行的编码方式: if (condition) statements; 4....【强制】 所有的类都必须添加创建者和创建日期。 【强制】 方法内部单行注释,在被注释语句上方另起一使用//注释。方法内部多行注释 使用/* */注释,注意与代码对齐。

96830

阿里Java编程规约【一】命名风格

强制】代码和注释中都要避免使用任何人类语言中的种族歧视性或侮辱性词语。...【强制】抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾,测试类命名以它要 测试的类的名称开始,以 Test 结尾。...【强制】类型与中括号紧挨相连来定义数组。 正例:定义整形数组 int[] arrayDemo。 反例:在 main 参数中,使用 String args[] 来定义。 9....【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形 式,但是类名如果有复数含义,类名可以使用复数形式。...说明:子类、父类成员变量名相同,即使是 public 也是能够通过编译,而局部变量在同一方法内的不同代码块中同名 也是合法的,但是要避免使用

61220

googl中java、c++编程风格

4.1 大括号    4.1.1 使用括号(即使是可选的) 大括号与if,else,for,do,while语句一起使用,即使只有一条语句(或是空),也应该把大括号写上。    ...如果在赋值运算符处断开,通常的做法是在该符号后断开(比如=,它与前面的内容留在同一)。这条规 则也适用于foreach语句中的分号。   3. 方法名或构造函数名与左括号留在同一。    4....分隔任何保留字与紧随其后的左括号(()(if,forcatch等)。   2. 分隔任何保留字与其前面的右大括号(})(else,catch)。   3....例外:单个的注解可以和签名的第一出现在同一。例如: @OverridepublicinthashCode(){...} 应用于字段的注解紧随文档块出现,应用于字段的多个注解允许与字段出现在同一。...4.8.6 注释 4.8.6.1 块注释风格  块注释与其周围的代码在同一缩进级别。它们可以是/*...*/风格,也可以是//...风格。对于多行的/*...

1K20

这可能是最全最实用的Vim操作集合

,当该符号在方括号表达式中使用时,表示不接受该方括号表达式中的字符集合。...要匹配 * 字符,请使用 \* | 指明两项之间的一个选择 () 标记一个子表达式的开始和结束位置,注意括号在vim中使用需要加\,即\( ...... .........5.2 多行注释和去注释 多行注释: 方式一(推荐) 按 ESC 键 将光标定位到你想开始注释的那一,然后,按 ctrl + v,启动可视模式 使用向下箭头(⬇)选择要注释 然后按 shift +...,然后,按 v 或 V,启动可视模式 使用向下箭头(⬇)选择要注释 然后输入 : 进入命令模式,紧接着输入 normal i// 或 normal i== 之类的,即可在可视模式下选中的多行行首加入...8.2 主题配置 配置主题是为了赏心悦目,试过在 VS Code 中使用 Vim 插件,有部分高级功能无法正常使用,虽然结合 VS Code 也是比较漂亮的,但不好用这一点就有点遗憾了,需要插件开发者去解决相关问题

2K20
领券