本主题解释了如何创建并自定义编码标准工具,验证代码是否遵循一组用户定义的自定义规则和/或内建规则。
本章包含:
了解编码标准
编码标准工具验证代码是否遵循规则,这些规则验证从特定语言的 W3C 准则到团队命名规范,到项目特定设置要求,到自定义 Xml 标签的正确使用。
当创建新的编码标准实例时,可以将其配置为检查自定义规则和内置规则的任意数量或组合。自定义规则可以验证应用程序特定的设计和内容需求,执行自定义编码标准,执行命名规范,识别表示问题的文本(如异常消息),查询 XML 数据,甚至执行自定义文件转化。
可以在 RuleWizard 工具中创建自定义规则,该工具可以自动生成规则,或帮助你以图形方式创建规则。有关设置自定义规则的更多详情,请查阅 RuleWizard 用户指南(在 RuleWizard GUI 中选择 Help> RuleWizard Documentation )。
通常情况下,用户创建自定义编码标准工具来检查一组逻辑自定义规则。例如,如果团队实现的规则检查项目特定的设计指导原则、团队的命名指导原则以及每个团队成员最常见的编码错误,则他们可能希望创建三个单独的编码标准工具,用于每个逻辑规则组。
配置编码标准
通过指定希望用于检查的规则配置编码标准工具。在配置面板中,你可以:
- 通过选择或清除可用的多选框启用或禁用单条规则或规则组。
- 通过右键单击并从快捷菜单中选择 查看/改变规则参数 自定义参数化规则。参数化规则使用特定图标(有单选按钮的向导帽)来标记。
- 单击 Find 按钮,然后使用该对话框搜索规则。
- 单击 Hide Disabled 按钮隐藏未启用的规则。如果希望稍后显示所有的规则,单击 Show All。
- 右键单击代表该规则的节点,然后从快捷菜单选择 View Rule Documentation 查看规则说明。