文件命名

本节以 Markdown 语言编写的技术文档为例,介绍源文件的命名规范。如下所示。

  • 文件名应该能对文档内容进行简要概括。

  • 文件名不宜过长。

  • 当文件名由多个英文单词组成时,单词中间应当由短划线“-”隔开。

  • 不建议在文件名中使用下划线“_”。在 URL 中出现下划线不利于搜索引擎优化,且下划线在部分 Markdown 实现中是修饰字符。

  • 当文件名由多个英文单词组成时,文件名建议使用全小写单词,全大写亦可接受,如 FAQ.md。

  • 文件名禁止大小写混用。

  • 文件后缀名应当使用小写形式。

  • Markdown 文件应当使用“.md”后缀,“.markdown”亦可接受,但要保证风格统一。