方法命名是否需遵循语法?求复杂方法命名规则
方法与变量命名的实用规则
核心原则:可读性优先,语法次之
代码命名的核心是让其他开发者(包括未来的你)一眼看懂含义,自然英语语法是参考,但绝非硬性要求。像openCreateUserModal这种命名,业内普遍接受,没人会纠结“双动词”的语法问题——因为所有人都能快速理解这是「打开创建用户的模态框」的方法,反而openCreatingUserModal会显得生硬冗余。
动作类方法的常见命名模式
- 动作+目标:这是最直观的模式,比如
openCreateUserModal(动作open,目标是createUserModal)、deleteSelectedItems(动作delete,目标selectedItems),不需要刻意把动词改成动名词。 - 动名词作定语的场景:只有当目标本身是一个正在进行的动作流程时,才适合用动名词,比如
handleCreatingUserSubmit(处理创建用户的表单提交动作),这种场景下核心动作是“提交创建用户的表单”,而非单纯打开模态框。 - 拒绝过度语法纠结:比如别为了凑语法把
getUserList改成getUseringList,前者清晰易懂,后者反而别扭到让人费解。
复杂方法的命名技巧
- 拆分核心动作与细分场景:如果方法逻辑包含多个步骤,把关键动作和场景都体现出来,比如
validateAndSubmitCreateUserForm(验证并提交创建用户表单),用And连接多个动作,清晰展示方法的核心流程。 - 用通用前缀/后缀明确类型:比如
init(初始化)、handle(处理事件)、fetch(获取数据)、update(更新)这些前缀,能快速让别人知道方法的类型;后缀比如Modal、Form、List则明确目标对象。 - 避免非通用缩写:不要把
createUser写成crUsr,除非是API、URL这种所有人都懂的行业通用缩写,可读性永远比简洁重要。 - 保持团队风格一致:如果团队统一用
openXXModal,就别突然改成launchXXModal,统一的命名风格能大幅减少理解成本。
内容的提问来源于stack exchange,提问作者undefined
相关产品推荐
相关产品推荐

