Documentation文档入门


版本

发布日期
私人测试版 2016年3月26日
1 2016年7月25日
2 2016年8月4日
3 2016年8月29日
4 2016年9月12日
2016年9月29日
6 二○一六年十月二十○日
7 2016年11月29日

关于文档

什么可以记录?

  • 各种语言的功能示例。
  • 每个标签的简要介绍。

问题与主题有什么区别?

  • 主题的范围比问题更广泛;作为问题提出的文档主题可以关闭,因为它们太宽泛。
  • 主题应该有多个例子;具有单个示例(例如,一个代码块)的主题可以提供的请求可能太窄。

你好,世界

一个hello world主题应该包含可用的最基本,完整,可运行的入门程序,这可以通过所记录的语言,框架或系统的最广泛版本来实现。如有必要,备注应包括有关如何准备和执行示例的基本说明。

该主题通常不需要多于一个或两个示例,除非该语言的更高版本不向后兼容。请记住,hello world主题将成为刚开始学习语言的人的起点。因此,它应该展示学习者可以用来实现正确程序的最小工作示例。它不一定是展示语言最新功能的地方。