diff --git a/doc/03-为什么拒绝使用代码格式化工具.md b/doc/03-为什么拒绝使用代码格式化工具.md index c781a98..7dfad59 100644 --- a/doc/03-为什么拒绝使用代码格式化工具.md +++ b/doc/03-为什么拒绝使用代码格式化工具.md @@ -92,11 +92,11 @@ if (!matched) matched = iterate_menu (chsrc_wr_menu, input, &target_tmp); // 一般函数调用都空格,因为这是 GNU 风格最显著的特征之一 func (1, 2); -// 这两种情况不用保持空格,因为没有必要 +// 当函数参数为0或1时不用保持空格,因为能更紧凑一些 br(); red("string"); -// 但如果有函数嵌套,即使参数只有1个,外部函数还是要保持空格,这样清晰地多 +// 但如果有函数嵌套,即使参数只有1个,外部函数还是要保持空格,这样清晰得多 func1 (func2("string")); // 如果参数过长,即使参数只有1个,也应该保持空格 red ("loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong string"); @@ -106,6 +106,18 @@ red ("loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong stri +## Markdown 写作风格 + +维护者很多时候不是从渲染好的界面来看 Markdown 文件的,而是阅读 Markdown 源文件,所以 Markdown 在源文件层面也要易读。 + +我们保持每个主题之间 **1个`
` + 3个空行** 的简单风格。 + +拒绝使用 VS Code 的 `markdownlint` 插件,**因为它总是用它狭隘的标准给我们增加了巨多的黄色下划线**。 + +
+ + + ## 其他语言代码风格 我们秉承 **入乡随俗、尊重传统** 的原则,尊重每种语言社区的既定传统。比如,`YAML` 使用2个空格,`JSON`使用4个空格,`Perl` 使用 Larry Wall 钟爱的4个空格。