代码规范

请遵循以下准则

  • 不要在包安装中使用“–y”

    在描述包安装时,不要使用 -y 选项。 而是使用 apt-get install packageyum install packagezypper install package

  • 使用“–选项 参数”

    OpenStack CLI 支持 --option ARGUMENT--option=ARGUMENT 两种形式。 在技术文档中,请使用 --option ARGUMENT

  • 使用大写字母和下划线表示参数

    在示例命令中编写参数时,请使用大写字母表示参数,并使用下划线作为分隔符。 例如

    $ openstack user create --project PROJECT_A --password PASSWORD USERNAME
    

    如果需要,请在示例命令块之后立即描述参数。 例如,对于 PASSWORD 参数

    Replace ``PASSWORD`` with a suitable password.