命令参考

命令参考使用户了解编程选项和预期行为。理想情况下，参考 内容应包含在源代码中，作为文档字符串或其他允许您 自动生成 文档的标记。这使得在开发工作流程中将文档维护作为一部分变得更容易，从而提高了技术准确性。将参考内容与代码内联也有助于将文档网站集中在面向任务的内容上，并清理用户指南等。

命令参考通常遵循手册页的结构，您可以使用 Sphinx 生成手册页。

以下是一些命令参考应该包含的部分

描述

描述提供对预期命令用法的简要概述，一到两句话即可。

概要

概要简要概述主要命令用法。

选项

列出每个命令的选项并提供简短的描述。

示例

演示在给定环境中实际命令用法的有效示例。