风格指导

PostgreSQL 9.4.4 中文手册
上一页 | 上一级 | 附录 J. 文档 | 下一页

# J.5. 风格指导

## J.5.1. 参考页

参考页应该遵循标准的布局。这样就允许用户更快地找出自己需要的信息， 并且也可以鼓励作者把一条命令的所有相关方面都记录在案。一致性不仅仅是 PostgreSQL参考页的需求，也是操作系统和其它页面提供的东西。 因此设计了下面的指导方针。它们在大多数时候是与各种操作系统建立起来的类似的风格是一致的。

描述可执行命令的参考页应该包含下面的小节，并且是按照这里的顺序。 不适用的小节可以忽略。额外的顶级小节应该只用在特殊的环境下； 通常那些信息属于"用法"小节。

名字（Name）

  这个小节是自动生成的。它包含命令名和一个半句话的摘要，介绍该命令的功能。

纲要（Synopsis）

  这个小节包含该命令的语法图表。大纲通常不应该列出每个命令行选项；那些东西在后面做。 大纲应该列出命令行的主要组件，比如应该把输入和输出文件放在哪里等。

描述（Description）

  几个段落，用于描述该命令是做什么的。

选项（Options）

  一个列表，描述每个命令行选项。如果有许多选项，可以用子小节。

退出状态(Exit Status)

  如果程序用 0 表示成功，非零表示失败，那么你不需要为此写文档。 如果在每个非零值的后面有不同的含义，那么在这里列出它们。

用法(Usage)

  描述任意子语言或者程序的运行时接口。如果程序不是交互的，那么本节通常可以省略。 否则，本节是用于描述所有运行时特性的地方。如果合适，可以使用子小节。

环境(Environment)

  列出所有程序可能使用的环境变量。尽量完整；即使是那些看起来很琐碎的变量， 比如`SHELL`都可能让读者感兴趣。

文件(Files)

  列出所有程序可能隐含访问的文件。也就是说，不要列出在命令行上声明的输入和输出文件。 但是列出配置文件等等。

诊断(Diagnostics)

  解释任何程序可能生成的不正常的输出。避免列出所有可能的错误消息。 这样做工作量很大但没有太多实际用途。但是如果说错误消息有一种用户可以分析的标准格式， 那么这里可能就是解释它的地方。

注意(Notes)

  任何在其它地方放都不合适的东西，尤其是Bug、实现缺陷、安全考量、兼容性问题等。

例子(Examples)

  例子

历史(History)

  如果在程序的历史中有一些主要的里程碑，那么可以在这里列出。通常，这个小节可以省略。

作者（Author）

  作者（只在普通发布版中使用）

又见(See Also)

  交叉引用，按照下面的顺序列出：其它PostgreSQL 命令的参考页PostgreSQL SQL命令参考页、 PostgreSQL 手册的引用、其它引用页面(比如， 操作系统、其它包)、其它文档。在同一组里的条目按照字母顺序列出。

描述 SQL 命令的参考页应该包含下面的小节：名字、大纲、描述、参数、输出、注意、例子、 兼容性、历史、又见。参数小节类似选项小节，但是有更多自由可以选择该命令的哪个子句可以列出。 输出小节只在命令有返回的时候需要，而不是缺省的命令结束标签。 兼容性小节应该解释此命令遵循 SQL 标准的哪个扩展，或者它兼容哪种其它数据库系统。 SQL 命令的"又见"小节应该在交叉引用其它程序之前列出 SQL 命令。

上一页 | 起始页 | 下一页
文档写作 | 上一级 | 首字母缩略词