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

Markdown Rules 详解

,有的解释器会要求列表中的空行要缩进 MD010 - Hard tabs 不能使用tab来进行缩进,要使用空格 参数: "code_blocks":指定本条规则在代码块里是否(true or false...文档中不能有连续的空行(文档末可以有一个空行),在代码块中这个规则不会生效 参数: "maximum":指定文档中可以连续的最多空行数,默认值是1 MD013 - Line length 默认行的最大长度是...":指定规则是否(true or false)对代码块生效,默认true "tables":指定规则是否(true or false)对表格生效,默认true "hesdings":指定规则是否(true...,默认是1 MD031 - Fenced code blocks should be surrounded by blank lines 单独的代码块前后需要用空行隔开(除非是在文档开头或末尾),否则有些解释器不会解释为代码块...":字符串数组,指定要检查需要大写的名称,默认是空("null") "code_blocks":指定本规则是否(true or false)对代码块生效,默认是true 一些经常使用的名称可以使用本规则防止其拼写错误

88530

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

例外:两个连续字段之间的空行是可选的,用于字段的空行主要用来对字段进行逻辑分组。 在函数体内,语句的逻辑分组间使用空行。...在, : ;及右括号())后 如果在一条语句后做注释,则双斜杠(//)两边都要空格。这里可以允许多个空格,但没有必要。...4.8.2.2 需要时才声明,并尽快进行初始化 不要在一个代码块的开头把局部变量一次性都声明了(这是c语言的做法),而是在第一次需要使用它时才声明。...在决定一个字段是否是一个常量时, 考虑它是否真的感觉像是一个常量。例如,如果任何一个该实例的观测状态是可变的,则它几乎肯定不会是一个常量。...这个片段是非常重要的,在某些情况下,它是唯一出现的文本,比如在类和方法索引中。 这只是一个小片段,可以是一个名词短语或动词短语,但不是一个完整的句子。

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

    Java编程风格

    例外:两个连续字段之间的空行是可选的,用于字段的空行主要用来对字段进行逻辑分组。 在函数体内,语句的逻辑分组间使用空行。...3.8.6 注释 3.8.6.1 块注释风格 块注释与其周围的代码在同一缩进级别。它们可以是 /*…*/ 风格,也可以是 //… 风格。...双斜线( // )一般用于注释一条语句。/*…*/用于注释一段代码块。 3.8.7 修饰符 类和成员的修饰符如果存在,则按Java语言规范中推荐的顺序出现。...在决定一个字段是否是一个常量时, 考虑它是否真的感觉像是一个常量。 例如,如果任何一个该实例的观测状态是可变的,则它几乎肯定不会是一个常量。...这个片段是非常重要的,在某些情况下,它是唯一出现的文本,比如在类和方法索引中。 这只是一个小片段,可以是一个名词短语或动词短语,但不是一个完整的句子。

    2.1K20

    Google Java 编程风格指南

    - 例外:两个连续字段之间的空行是可选的,用于字段的空行主要用来对字段进行逻辑分组。 在函数体内,语句的逻辑分组间使用空行。...foreach语句中的分号。 在 ,:;及右括号( ))后 如果在一条语句后做注释,则双斜杠(//)两边都要空格。这里可以允许多个空格,但没有必要。 类型和变量之间:List list。...4.8.2.2 需要时才声明,并尽快进行初始化 不要在一个代码块的开头把局部变量一次性都声明了(这是c语言的做法),而是在第一次需要使用它时才声明。...在决定一个字段是否是一个常量时, 考虑它是否真的感觉像是一个常量。例如,如果任何一个该实例的观测状态是可变的,则它几乎肯定不会是一个常量。...这个片段是非常重要的,在某些情况下,它是唯一出现的文本,比如在类和方法索引中。 这只是一个小片段,可以是一个名词短语或动词短语,但不是一个完整的句子。

    1.1K11

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

    - 例外:两个连续字段之间的空行是可选的,用于字段的空行主要用来对字段进行逻辑分组。 在函数体内,语句的逻辑分组间使用空行。...foreach语句中的分号。 在 ,:;及右括号( ))后 如果在一条语句后做注释,则双斜杠(//)两边都要空格。这里可以允许多个空格,但没有必要。 类型和变量之间:List list。...4.8.2.2 需要时才声明,并尽快进行初始化 不要在一个代码块的开头把局部变量一次性都声明了(这是c语言的做法),而是在第一次需要使用它时才声明。...在决定一个字段是否是一个常量时, 考虑它是否真的感觉像是一个常量。例如,如果任何一个该实例的观测状态是可变的,则它几乎肯定不会是一个常量。...这个片段是非常重要的,在某些情况下,它是唯一出现的文本,比如在类和方法索引中。 这只是一个小片段,可以是一个名词短语或动词短语,但不是一个完整的句子。

    96440

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

    例如:两个连续字段之间的空行是可选的,用于字段的空行主要用来对字段进行逻辑分组。 2、在函数体内,语句的逻辑分组间使用空行。...4.8.2.2 需要时才声明,并尽快进行初始化 不要在一个代码块的开头把局部变量一次性都声明了(这是c语言的做法),而是在第一次需要使用它时才声明。...例如: @Partial @Mock DataLoader loader; 参数和局部变量注解没有特定规则。 4.8.6 注释 4.8.6.1 块注释风格 块注释与其周围的代码在同一缩进级别。...在决定一个字段是否是一个常量时, 考虑它是否真的感觉像是一个常量。例如,如果任何一个该实例的观测状态是可变的,则它几乎肯定不会是一个常量。...这个片段是非常重要的,在某些情况下,它是唯一出现的文本,比如在类和方法索引中。 这只是一个小片段,可以是一个名词短语或动词短语,但不是一个完整的句子。

    2.8K40

    最全面的 Android 编码规范指南

    4.8.4.1 缩进 与其它块状结构一致,switch块中的内容缩进为2个空格。每个switch标签后新起一行,再缩进2个空格,写下一条或多条语句。...4.8.4.2 Fall-through:注释 在一个switch块内,每个语句组要么通过break, continue, return或抛出异常来终止,要么通过一条注释来说明程序将继续执行到下一个语句组...例如: @Partial @Mock DataLoader loader; 参数和局部变量注解没有特定规则。 4.8.6 注释 4.8.6.1 块注释风格 块注释与其周围的代码在同一缩进级别。...在决定一个字段是否是一个常量时,考虑它是否真的感觉像是一个常量。 例如,如果任何一个该实例的观测状态是可变的,则它几乎肯定不会是一个常量。...这个片段是非常重要的,在某些情况下,它是唯一出现的文本,比如在类和方法索引中。 这只是一个小片段,可以是一个名词短语或动词短语,但不是一个完整的句子。

    1.7K40

    【高效编程技巧】编程菜鸟和编程大佬的差距究竟在哪里?

    各位宝子们大家好啊,今天来给大家细谈一下,菜鸟和编程大佬的差别究竟在哪里? ⛳️是否有很多人觉的自己的代码已经写的很不错的时候,看到大佬的代码是否会想啊!!!我的代码毛病怎么这么多。...如只定义一个变量或只写一条语句。...这样的代码容易阅读,并且方便于写注释。 if、for、while、do 等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。...【规则二】{ }之内的代码块在‘{’右边数格处左对齐。 示例: 2-4(a)为风格良好的对齐,示例 2-4(b)为风格不良的对齐。...你们的点赞就是博主更新最大的动力! 有问题可以评论或者私信呢秒回哦。

    12010

    良好的CSS编码习惯

    : 以字母开头,避免数字开头 全部用小写,这样的话不容易在引用的时候因为大小写而出错 用-来分隔单词,而不是下划线 对于压缩过的文件,比如 css 或者 js 文件,使用 .min 代替 -min 设置编码...在 css 文件的最顶部设置编码格式为 utf-8 ,否则有可能使得 css 文件出现乱码。...单行注释的前面需要一个空行。 一个规则里存在多个选择器的时候,每个选择器的逗号后换行。 一个声明块里有多个声明的时候,每条声明后都需要换行;只有一条声明的时候,声明和选择器同行。...对于逗号分隔且非常长的属性值,可以考虑换行并且缩进一个制表符。 media query 声明的第一行空行,这样就不会和第一条声明杂在一起,显得拥挤。...比如声明的顺序、属性和值的写法以及一些个例等。 声明的顺序 在 css 中存在好几百个属性,如果需要一个 css 规则里几乎可以写满这些属性。

    59020

    Google Java编程风格指南

    4.1.3 空语句块:使代码更简洁 一个空的语句块,可以在左大括号之后直接接右大括号,中间不需要空格或换行。但是当一个由几个语句块联合组成的语句块时,则需要换行。...4.6.2 水平空白 除了语法、其他规则、词语分隔、注释和javadoc外,水平的ASCII空格只在以下情况出现: 所有保留的关键字与紧接它之后的位于同一行的左大括号之间需要用空格隔开。...例如:int a, b;是不允许的。 4.8.2.2 需要时才声明,尽快进行初始化 不要在一个代码块的开头把局部变量一次性都声明了(这是c语言的做法),而是在第一次需要使用它时才声明。...4.8.4.2 继续向下执行的注释 在一个switch块内,每个语句组要么通过break、continue、return或抛出异常来终止,要么通过一条注释来说明程序将继续执行到下一个语句组,任何能表达这个意思的注释都是可以的...当整个Javadoc块能容纳于一行时(且没有标记@XXX),就可以使用单行形式。 7.1.2 段落 空行(只包含最左侧星号的行)会出现在段落之间和Javadoc标记(@XXX)之前(如果有的话)。

    1K20

    python基础教程:Python 基本语法

    Python 作为一门计算机语言自然有它自己的语法规则,就像英语、汉语都有自己的语法规则一样。Python的语法以简洁著称,它以行、缩进、注释、标识符、保留关键字等几方面来规定了自己的语法。...') 空行 空行也是一种行(内容为空),也是代码的一部分。...可以用在名称中的字符有: 大写字母: A-Z 小写字母: a-z 阿拉伯数字: 0-9 下划线: _ 更多的Unicode字符:你可以用中文给变量起名字 标识符(起名字)可以包括以上字符,但是不能以数字开头...Python2只支持ASCII码作为标识符的字符集, 而Python 3 扩展了标识符字符集,我们可以在程序中起中文名字,但是打中文会累死人的哦。...保留的类标识符 这些类的标识符有特殊的含义,它们都是以下划线_开头和结尾的形式: _* 不会被语句from module import *导入。 __*__ 系统定义的名称。

    68331

    googl中java、c++编程风格

    4.8.2.2 需要时才声明,并尽快进行初始化 不要在一个代码块的开头把局部变量一次性都声明了(这是c语言的做法),而是在第一次需要使用它时才声 明。...例外:单个的注解可以和签名的第一行出现在同一行。例如: @OverridepublicinthashCode(){...} 应用于字段的注解紧随文档块出现,应用于字段的多个注解允许与字段出现在同一行。...例如: @Partial@MockDataLoaderloader; 参数和局部变量注解没有特定规则。   4.8.6 注释 4.8.6.1 块注释风格  块注释与其周围的代码在同一缩进级别。...定义:在极造函数中执行初始化操作。 优点:排版方便,无需担心类是否初始化。 缺点:在极造函数中执行操作引起的问题有:   1) 极造函数中丌易报告错诨,丌能使用异常。  ...注:至于子类没有额外数据成员,甚至父类也没有仸何数据成员的特殊情冴下,枂极函数的调用是否必要 是诧义争论,从编程设计觃范的角度看,在吨有虚函数的父类中,定义虚枂极函数绝对必要。

    1K20

    说说Python编码规范

    在遵守这个文档的条件下,不同程序员编写的Python代码可以保持最大程度的相似风格。 这样就易于阅读,易于在程序员之间交流。 下面就说说Python编码时,应该遵守的编码规范有哪些。...,然后用 ; 隔开 if/for/while 语句中,即使执行语句只有一句,也要另起一行 在类、函数的定义间加空行; 在import不同种类的模块间加空行; 在函数中的逻辑段落间加空行,即把相关的代码紧凑写在一起...注释 为了提高可读性, 块注释和行注释注释应该至少离开代码2个空格. 块注释,在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。...实现方法有两种,一是all机制;二是前缀一个下划线。 函数命名使用全部小写的方式,可以使用下划线。 常量命名使用全部大写的方式,可以使用下划线。...类的属性有3种作用域public、non-public和subclass API,可以理解成C++中的public、private、protected,non-public属性前,前缀一条下划线。

    70330

    ESLint静态代码检查

    "no-implicit-coercion": "error" 禁止出现空函数.如果一个函数包含了一条注释,它将不会被认为有问题。..."lines-around-comment": ["error", { "beforeBlockComment": true }] 要求在注释周围有空行 ( 要求在块级注释之前有一空行)。..."space-before-blocks": ["error","always"] 强制在块之前使用一致的空格。 忽略检测 既然有检测的规则,那么必然有忽略检测的配置。...现在我们就可以到terminal里面输入$ npm run lint,来检验项目里的代码是否符合ESLint的规则。...在报这么多的错误之后,如果我们一条一条地去修复,就会变的非常的麻烦,相信刚接触ESLint的童鞋都深有体会。其实这些错误都可以让ESLint帮助我们自动地修复。

    2.1K20

    一、代码风格 1、假定你的代码需要维护2、保持一致性3、考虑对象在程序中存在的方式,尤其是那些带有数据的对象4、不要做重复工作5、让注释讲故事6、奥卡姆剃刀原则1、简洁的规则2、文档字符串3、空行4、

    在应用程序中你是否拥有大量的重复代码?如果这些重复代码行数较多,可以先将其抽象到一个函数中去,如果出现修改的必要,则更容易管理。 另一方面,对于这个原则不要过犹不及。...写一条‘不要使用三元运算符‘’很容易,然而仅遵守这些规则(虽然有价值)并不是代码明细的充分条件。应该重点关注以尽可能简洁的方式编写和组织代码。...只有在关键字参数的情况下该规则不适用,在这种情况下,空格可以省略。 在列表和字典省略不必要的空白(例如:[1,2,3,4]而不是[ 1,2,3,4 ])。...如果文档是多行,则将结束的双引号单独的放一行。 3、空行 空行用于逻辑分块。 PEP 8规定“最高级”的类和函数定义之间有两个空行。...class A(object): def foo(self): pass def bar(self): pass 在函数或其他的代码块中使用单空行分隔逻辑段是合理的

    1.1K50

    技术规范(2): 后端技术开发规范

    Python要求将来在模块中的导入,必须出现在除文档字符串之外的其他代码之前。 """This is the example module....块注释通常适用于跟随它们的某些(或全部)代码,并缩进到与代码相同的级别。块注释的每一行开头使用一个#和一个空格(除非块注释内部缩进文本)。块注释内部的段落通过只有一个#的空行分隔。...(5)全局变量名和函数命名规则一样,值得注意的是通过 from M import * 导入的模块应该使用all机制去防止内部的接口对外暴露,或者使用在全局变量前加下划线的方式。...包注释必须出现在 package 声明的临近位置,无空行。所有的顶级导出的名称都应该有 doc 注释,重要的未导出类型或函数声明也应如此。...名称可以非常短,因为它几乎出现在每种类型的每个方法的每一行上。 接收器什么时候使用值或者指针: (1)小的不变结构或基本类型可以用值接收器。这样可以提高效率。

    1.1K20

    reStructuredtext快速入门

    在必要的时候,.rst文件可以被转化成PDF或者HTML格式,也可以有Sphinx转化为LaTex,man等格式,现在被广泛的用于程序的文档撰写。...第三条 第二条开始后续的条目用 # 开头。第一条的序号不必从 1 开始。 顺序列表包括如下符号样式: 1. 数字 a. 小写字母 A....大写字母 i) 小写罗马数字 (I) 大写罗马数字 列表前后, 以及条目之间必须有空行隔开. 列表下面可以插入任意的内容, 段落, 图片都可以, 只要他们的左侧和列表的第一个文字左对齐。...*鸭* 鸡的崇拜者 嵌入程序代码 如果需要嵌入大段的程序代码(SQL, 业务逻辑设置, 配置文件等), 在段落末尾添加两个’:’, 并且代码块需要与周围文本以空行分隔,代码的左侧必须缩进, 代码引用到没有缩进的行为止...也是reST 的扩展规则, 在 Sphinx 经常被用到。

    1.5K20

    PHP的基本规则

    不正确的写法将导致PHP解析器认为key是一个常量,进而先判断常量是否存在,不存在时才以key作为下标传入表达式中,同时触发错误事件,产生一条Notice级错误。...必须清楚所使用英文单词的词性,在权限相关的范围内,大多使用enable、is的形式,前者后面接动词,后者后面接形容词。 下面是一些基本的命名规则: 名称的开头不能使用数字及特殊符号。...用array声明有索引的数组,在每个逗号的后面间隔空格以提高可读性: $exampleArray = array(a, b, c, 'PHP', 'Studio'); 也可以用array声明多行有索引的数组...块注释被置于每个文件的开始处以及每个方法之前,也可以被用于其他地方,如方法内部。在功能和方法内部的块注释应该和它们所描述的代码具有一样的缩进格式。...块注释起始处应该有一个空行,用于把块注释和代码分隔开,例如: /* * 这里是块注释 */ 5.单行注释 短注释可以显示在一行内,并与其后的代码具有一样的缩进层级。

    5.1K50

    gitignore文件「建议收藏」

    sudo ls查看目录下是否存在gitignore,有则表示成功 如果之前没有提交过第三方到远端,则按照正常情况,commit一下再push到远端就完成了 如果之前提交过得话,则输入指令git rm -...Podfile.lock 我该如何编写 gitignore 文件 gitignore文件中, 一行对应一条规则 空行被自动忽略, 可以随便插入若干行空行, 你可以作为不同类型规则的分割线 以#...开头的规则被认为是注释, 会被自动忽略....如果你想过滤一个 以#开头的文件, 可以在#之前加一个 反斜杠\, 如 # 这是注释, 下面一条规则会过滤 #.txt 这个文件 \#.txt 会自动去除规则前后的空格, 如果你想要过滤文件名中头尾含有空格的文件...开头的规则表示例外规则,会将符合规则的文件重新加入版本控制中. 不过如果某文件的某个祖先文件夹被过滤了, 是不可能通过单独写一条例外规则来让这个文件重新加入版本控制中的.

    48920

    如何优化前端页面 如何优化网页

    2.2.3 合理书写注释,代码缩进合理,不出现多余空行或者空标签,提升代码可读性。 2.2.4 权衡嵌套层级以及扩展性等多个方面后,在适当位置使用三层嵌套技术。...3 样式 3.1 基本代码规范 3.1.1 CSS规则命名中,一律采用小写加中划线的方式,不使用下划线或大写字母,命名采用更简明有语义的英文单词进行组合,进行合理的缩写 3.1.2 CSS代码的书写顺序遵循...4.3.4 可以通过事件委托,减少页面中类似事件的数量。 4.3.5 在删除dom节点之前,需要先移除掉该节点上的事件。...4.4.5 合理使用计时器,防止setInterval造成的内存泄露。 4.4.6 在设置计时器之后需要考虑计时器的清除,以防止计时器的叠加造成的影响。...5.3 对于网页中特殊的字体,可以使用@font-face进行设置,并根据实际情况修改字体包,防止字体包文件过大。

    2.5K80
    领券