您已购买HotDocs开发者许可证，研读过教程，甚至可能接受过开发培训。您或许还深入查阅了HotDocs帮助文件中的相关主题，或浏览过HotDocs维基。无论如何，您已准备好为您的法律事务所或企业开发HotDocs流程应用程序。
您的培训和阅读已让您了解到，HotDocs的核心功能围绕着您创建的组件（或变量）展开。（组件是指在组件文件中创建的、与文档模板关联的任何内容[例如对话框、变量等]。） 因此您或许意识到，组件的命名规范对HotDocs流程应用程序的长期功能性和可维护性至关重要。以下三条命名规则将助您开启HotDocs开发之旅：
禁用字符与被放逐的案例
组件名称应相对简短且富有意义。组件名称最多可包含50个字符，包括字母、数字及部分符号。但首字符必须为字母。每个组件名称必须唯一——即使组件类型不同，其名称也不能相同。
下列字符仅可在其前后紧邻非空格字符时使用；但强烈建议避免使用这些字符。 强烈不建议，鉴于HotDocs未来可能的变更：
你 不能 在命名组件时使用以下字符：
最后，由于HotDocs采用全大写字母作为其指令和表达式模型，最佳实践是 完全避免 在命名组件时使用大写字母。例如，您不能将组件命名为“ADD ATTY TO MC”，因为“ADD”是HotDocs中的保留指令词。即使您在组件名称中将当前非指令或表达式模型的单词使用大写字母，也永远无法确定HotDocs是否会将您大写的单词添加到其保留词列表中。 因此建议采用"驼峰式大小写"、"句首大写"或"全小写"命名，切勿使用"全大写"——抱歉了。
属 > 物种/一般 > 特定
一种有助于在组件管理器中组织组件的实践，同时通常能保持 诸如此类 事物 如 的组件命名法是：以通用词汇开头，逐步递进至具体术语。例如，组件名称的根词可作为某组件或主题的核心关键词（如 Client名称）。该关键词通常作为组件名称的首词，但根据组件类型可能有所不同。后续词汇应逐步细化，必要时先描述次级分类，再具体化各方面属性（例如：客户不动产法律描述）。最佳实践是尽可能避免使用冠词和介词。若需在"NameOfClient"与"ClientName"之间选择，应采用后者。
实例
不浪费50个字符，不缺憾
此处我冒着引发口水战的风险。（对于不熟悉该术语的人来说，口水战是指在互联网开发论坛上，当持有对立且根深蒂固的编码理念（如微软与苹果产品之争）的拥护者们在讨论串中相互贬低时所引发的争论。） 对于那些已采用不同组件命名规范实现文档模板自动化的开发者，我的建议或许不切实际。但对初入行者，这值得考虑：请参照上述示例，采用"驼峰式"或"标题式加下划线"命名法为组件命名。
传统上，许多模板开发者采用匈牙利命名法来标识组件类型（例如TE代表文本），同时为提升可读性，常在组件名称中保留空格。自HotDocs 5版本起，使用匈牙利命名法的必要性已不复存在——新版HotDocs允许开发者在组件管理器中通过图标或文本形式查看组件类型，并能轻松进行搜索和排序。 关于空格问题，省略组件名称中的空格可让模板开发者在50个字符限制内腾出更多空间，用于添加描述组件功能的有效字符。此外，使用无空格组件名称（如"驼峰式命名法"）已成为HotDocs模型开发的默认标准（该主题值得在未来博文中深入探讨）。 遵循此规范可使HotDocs在读取模型文档时，将"无空格"变量名无误转换为访谈提示，避免因关闭严格命名规范而可能出现的错误。
最后需要考虑的是，随着HotDocs持续演进并与其他兼容技术保持一致，可能需要用户移除组件名称中的空格。若出现这种情况，HotDocs将提供转换含空格组件的方案，但若您从一开始就避免使用空格，便能领先于他人。归根结底，HotDocs脚本编写 本质上 一种编程语言，因此组件命名规范不仅要符合HotDocs模板开发要求，还应与其他编程或脚本语言保持一致性。
开发愉快！
编者按 本文最初发表于 HotDocs.com.2024 年 6 月，Mitratech 收购了高级文档自动化平台 HotDocs。此后，我们对内容进行了更新，以纳入与我们的产品、法规变化和合规性相一致的信息。
