Skip to content

编写规范

前言:

传承对于一个团队来说是十分重要的,而文字记载是最有效的方式(好记性不如烂笔头嘛),因此编写规范编写文档是十分有必要的。

Markdown

Markdoen语法简单,功能强大,用来编写文档十分方便,可以使用Typore或者VsCode进行编辑。

md语法:

Markdown 入门基础 | Markdown 教程

需要注意md的语法分为基础语法和拓展语法,如果你在编辑的时候使用了拓展语法,那么在不支持拓展语法的编辑器中打开显示的就是源代码。

排版

文档的排版几乎是和文档内容一样重要的东西,排版不行你的内容也不会好到哪里,同时好的排版有助于更好的编辑和阅读,因此排版问题需要格外注意。

关于排版的一些细节

爱情跟书写都需要适时地留白

排版官方文档

代码规范

参考战队代码编写规范:C编码风格与规范 - XJU-Hurricane-docs

还注意每一个项目完成后一定要编写README来对项目进行简单的说明