menu

在使用 Github 等工具时候,我们都会有一个疑惑: wikiREADME.md等内置文档 之间有什么区别?

Wiki

Github 文档介绍到,wiki 用于记载详细的内容,如设计书、代码规范和原则等等1

README.md

Github 文档介绍到,README.md 只是用来记载简单项目的简单情况。1

典型的 README.md 会包含以下信息:2

  • What the project does
  • Why the project is useful
  • How users can get started with the project
  • Where users can get help with your project
  • Who maintains and contributes to the project

但由于我们打开一个目录或项目时,会自动跳到该目录下的 README.md ,所以 README.md 还起到目录索引的作用。

注释 Comments

有时候大家会在代码的注释位置进行文档记载,但这种文档只是针对 当前的代码。这种文档常常是:

  • 介绍当前代码文件是如何使用
  • 一些 sample

参考 References