新手速查表:函数、方法和变量命名的常用动词
当你在你的职能中选择动词时,你会遵循你的直觉吗?
您是否不一致地使用多个同义词来达到同一目的?
如果答案是肯定的,那么您不是唯一一个。
为了编写干净的代码,或者至少尝试这样做,我们需要知道常用的词,以便我们可以使用它们,并且人们可以更容易地理解我们正在尝试做什么。
同时,我们需要坚持用一个词来表达一个概念,而不是不一致地使用同义词。
在这篇文章中,我将总结编程书籍和 Github 中常用的动词,无论编程语言类型如何,以便我们可以找到最适合我们自己需要的动词。
在下面的表格中,我们将看到 5 行:
- 动词
- 该动词在 Github 上出现的次数,让我们了解它的使用频率
- 它的一般定义
- 示例
- 避免使用同义词来表达同一概念
请耐心等待,这并不是一个完整的常用词汇列表,所以如果您发现某些定义对某些编程语言过于偏颇,请在评论中告诉我。如果您能教我其他您认为常用的动词,我将不胜感激!
我希望这篇文章能对我们有所帮助,新手可以选择一个合适的动词并坚持使用它。
目录
1️⃣变更
2️⃣创建
3️⃣建立
4️⃣获得
5️⃣判断题
6️⃣结论
1. 修改
动词 | 写 在 Github 上 |
定义 | 示例 | 应避免的同义词 |
---|---|---|---|---|
放 | 2B | 通常用于将数据放入现有资源中,例如对象的属性。 | 设置名称(),设置商店 ID() | |
改变 | 6.68亿 | 通常用于当整个事物(例如图像)被其他事物取代时 | 改变图像(),改变颜色() | 编辑 |
编辑 | 3.25亿 | 通常与 change 用法相同。尤其适用于 action 负责渲染视图的情况。 | 编辑标题(),编辑记录() | 改变 |
更新 | 7.39亿 | 通常用于当一个或多个组件因此而更新,并且还可以添加一些新内容时。 | 更新文件() | |
添加 | 1B | 通常用于将某物添加到一组事物中。 | 添加项目(),添加成员() | 附加 |
附加 | 2.87亿 | 通常与 add 用法相同。它可以用于不修改原有组但生成新组的情况。 | 追加项目(),追加元素() | 添加 |
消除 | 8.24亿 | 通常用于将某一特定事物从一组事物中移除时。 | 删除记录(),删除项目() | 删除 |
删除 | 4.55亿 | 通常与删除相同,但也可能造成无法恢复。 | 删除记录(),删除项目() | 消除 |
节省 | 4.78亿 | 通常在保存数据以避免丢失时使用。 | 保存json(),保存订单() | 店铺 |
店铺 | 3.96亿 | 通常使用方式与保存相同。 | store_json(),store_order() | 节省 |
禁用 | 5.86亿 | 通常用于配置资源不可用或非活动状态。 | 禁用用户() | 隐藏 |
隐藏 | 2.37亿 | 通常具有与禁用相同的意图,即通过隐藏它。 | 隐藏字段() | 禁用 |
分裂 | 2.76亿 | 用于分离资源的各个部分。 | 拆分表(),拆分组() | 分离 |
分离 | 1.51亿 | 通常与动词 split 的使用方式相同。 | 单独表(),单独组() | 分裂 |
合并 | 312米 | 通常用于从多个资源创建单个资源时。 | 合并记录(),合并表() | 加入 |
加入 | 2.2亿 | 它可以以与合并相同的方式使用。 | 连接记录(),连接表() | 合并 |
2. 创造
动词 | 写 在 Github 上 |
定义 | 示例 | 令人困惑的 同义词 |
---|---|---|---|---|
创造 | 1B | 创建资源时使用。 | 创建包(),创建目录() | 制造,生成 |
制作 | 797米 | 通常以与创建相同的方式使用。 | make_package()、make_statement() | 創造,生成 |
产生 | 2.86亿 | 通常以与创建相同的方式使用。 | 生成目录(),生成语句() | 創造,制造 |
复制 | 1B | 在创建与原始资源具有相同结构和数据的资源时使用。 | 复制文件(),复制图() | 克隆 |
克隆 | 1.47亿 | 可以按照与复制相同的方式使用。 | clone_file()、clone_graph() | 复制 |
3. 设立
动词 | 写 在 Github 上 |
定义 | 示例 | 令人困惑的 同义词 |
---|---|---|---|---|
开始 | 1B | 一般用于启动操作时。 | 开始监听() | 开始 |
开始 | 3.42亿 | 通常以与开始相同的方式使用。 | 开始监听() | 开始 |
打开 | 854米 | 用于改变资源的状态以使其可访问或可用。 | 打开文件() |
4. 获取
动词 | 写 在 Github 上 |
定义 | 示例 | 令人困惑的 同义词 |
---|---|---|---|---|
得到 | 2B | 一般用于获取某种资源。 | 获取数据(),获取商店 ID() | 取回,检索 |
拿来 | 1.46亿 | 可以按照与 get 相同的方式使用。 | fetch_data(),fetch_store_id() | 得到,检索 |
取回 | 1.16亿 | 可以像 get 或 fetch 一样使用 | 检索数据(),检索商店ID() | 得到,取回 |
读 | 1B | 从源获取数据时使用。 | 读取文件() | |
寻找 | 6.72亿 | 在容器中寻找未知数据时使用。 | find_element()、find_keyword() | 搜索 |
搜索 | 4.38亿 | 通常用法与 find 相同。它可能指从多个容器中查找未知数据。 | 搜索元素()、搜索关键字() | 寻找 |
关闭 | 4.92亿 | 用于改变资源的状态以使其不可访问或不可用。 | 关闭文件() |
5. 判断题
动词 | 写 在 Github 上 |
定义 | 示例 |
---|---|---|---|
是 | 3B | 在定义资源状态时使用。 | 方法:is_available()、is_correct() 变量:name_is_available、date_is_correct |
有 | 1B | 用于定义资源是否包含某个数据。 | 方法:has_name()、has_date() 变量:person_has_name、course_has_date |
能 | 2B | 用于定义资源的某项能力。 | 可以加载(),可以创建() |
应该 | 1B | 用于定义资源的某项义务。 | should_render(),should_print_message() |
6. 结论
编写简洁的代码并非一朝一夕就能掌握的技能。但与此同时,我相信通过学习他人简洁代码的智慧,我们可以显著且持续地提升代码质量。为了撰写这篇文章,我从Robert C. Martin 的《代码整洁之道》一书以及 Github 上的大量代码中汲取了许多灵感。我特别推荐这本书给编程新手。书中的许多内容对于新手来说可能有些高深,但我确信,这本书将成为我开发者生涯的永久参考书。
感谢这些分享自己辛勤劳动的人们!
感谢阅读。如果您有任何意见或疑问,请在下方留言!同时,请在领英上关注我@Maiko Miyazaki,或在推特上关注我@Maiko Miyazaki。
鏂囩珷鏉ユ簮锛�https://dev.to/maikomiyazaki/beginner-s-cheat-sheet-commonly-used-verbs-for-naming-functions-methods-and-variables-509i