Skip to content

代码

原则上,代码应当格式化后插入文档。

目前本站已部署自动化代码格式化工具,会在构建时自动执行格式化,目前覆盖的语言如下:

  • C/C++
  • JavaScript、TypeScript
  • CSS、SCSS、LESS
  • JSON、JSON5、JSONC
  • YAML
  • HTML
  • Vue、Angular
  • Markdown

其中,C/C++ 格式基于 LLVM,同时 Tab 宽为 4;其余语言使用 Prettier 默认配置。行长度最大为 75 字符,Tab 宽为 2。

但是仍然鼓励插入代码时进行格式化,以便发现潜在的语法错误。

对于部分需要关闭自动格式化的情况,请在代码块的第一行输入 // [!code escape-format]。例如:

markdown
```cpp
// [!code escape-format]
#include<iostream>
using namespace std;
int main()
{ cout << "Hello, world." << endl; return 0; }
```

将渲染为:

cpp
#include<iostream>
using namespace std;
int main()
{ cout << "Hello, world." << endl; return 0; }