个人中心
gpt4 book ai didi

Github标星7.9K！程序员专属的命名宝典来了

转载 作者：qq735679552 更新时间：2022-09-27 22:32:09 25 4
gpt4 key购买 nike

CFSDN坚持开源创造价值，我们致力于搭建一个资源共享平台，让每一个IT人在这里找到属于你的精彩世界.

这篇CFSDN的博客文章Github标星7.9K！程序员专属的命名宝典来了由作者收集整理，如果你对这篇文章有兴趣，记得点赞哟.

命名一直是程序员最烦恼的事情之一，一个好的命名可以让一段代码看起来可读性更强，后续维护的人员也会更轻松。因此，在团队中统一使用同一套命名规范是相当有必要的.

Github标星7.9K！程序员专属的命名宝典来了

今天，猿妹要和大家分享一份命名宝典，专门帮助程序员如何命名，这个项目介绍了命名时需要考虑的数个要点，旨在帮你解决命名困难的问题，教你如何便捷、轻松地进行命名，这个项目就叫——naming-cheatsheet.

Github标星7.9K！程序员专属的命名宝典来了

naming-cheatsheet已经在Github上标星 7.9K，累计分支 386 个（Github地址：https://github.com/kettanaito/naming-cheatsheet） 。

这些命名规则适用于任何编程语言，创建者以JavaScript为例演示，一起来看看吧:

英语命名 。

在命名变量和函数名时用英文名称命名:

  1. /* Bad */ 
  2.  
  3. const primerNombre = 'Gustavo' 
  4.  
  5. const amigos = ['Kate', 'John'] 
  6.  
  7. /* Good */ 
  8.  
  9. const firstName = 'Gustavo' 
  10.  
  11. const friends = ['Kate', 'John'] 

不管你喜欢与否，英语是编程中的主导语言，所有编程语言的语法都是用英语编写的，还有无数的文档和教学资料也是英文，通过英语编写代码，可以极大地增加代码的凝聚力.

约定命名 。

选择一套命名规范并遵循它，在团队中保持命名的一致性，它可以是camelCase、PascalCase、snake_case或其他任何东西。许多编程语言在命名约定方面都有自己的传统，你可以查看自己的编程语言文档或者学习一些Github上流行的知识库.

  1. /* Bad */ 
  2.  
  3. const page_count = 5 
  4.  
  5. const shouldUpdate = true 
  6.  
  7. /* Good */ 
  8.  
  9. const pageCount = 5 
  10.  
  11. const shouldUpdate = true 
  12.  
  13. /* Good as well */ 
  14.  
  15. const page_count = 5 
  16.  
  17. const should_update = true 

S-I-D命名原则 。

名称必须简短、直观和描述性:

  • 短：输入一个名称一定不要花太长时间，因此一定要简短
  • 直观：名称读起来一定要直观，尽可能贴近日常用语
  • 描述性：名称必须可以用最有效的方式反映它的作用
  1. /* Bad */ 
  2.  
  3. const a = 5 // "a" could mean anything 
  4.  
  5. const isPaginatable = a > 10 // "Paginatable" sounds extremely unnatural 
  6.  
  7. const shouldPaginatize = a > 10 // Made up verbs are so much fun! 
  8.  
  9. /* Good */ 
  10.  
  11. const postCount = 5 
  12.  
  13. const hasPagination = postCount > 10 
  14.  
  15. const shouldPaginate = postCount > 10 // alternatively 

避免过度的简写 。

不要使用缩写，它们只会降低代码的可读性，找到一个简短的可读的名称可能会很难，但即便如此也别使用简写.

  1. /* Bad */ 
  2.  
  3. const onItmClk = () => {} 
  4.  
  5. /* Good */ 
  6.  
  7. const onItemClick = () => {} 

避免重复命名 。

上下文的名称不应该重复 。

  1. class MenuItem { 
  2.  
  3. /* Method name duplicates the context (which is "MenuItem") */ 
  4.  
  5. handleMenuItemClick = (event) => { ... } 
  6.  
  7. /* Reads nicely as `MenuItem.handleClick()` */ 
  8.  
  9. handleClick = (event) => { ... } 
  10.  
  11. } 

反映预期结果 。

变量或函数的命名应该做到能够反映预期的结果.

  1. /* Bad */ 
  2.  
  3. const isEnabled = itemCount > 3 
  4.  
  5. return <Button disabled={!isEnabled} /> 
  6.  
  7. /* Good */ 
  8.  
  9. const isDisabled = itemCount <= 3 
  10.  
  11. return <Button disabled={isDisabled} /> 

以上就是命名的6大原则，除此之外，创建者还介绍了命名模式，诸如A/HC/LC模式、动作、前缀、单复数等模式，感兴趣的不妨自己去学习一下吧.

原文地址：https://mp.weixin.qq.com/s?__biz=MzA3NzA2MDMyNA==&mid=2650359277&idx=1&sn=f705be426ea5dca0fdc9b9f9b494760e&chksm=875a2466b02dad70d74268ccfa75356f344ec9030492631b7fda710f486da3230340c90dd287&mpshare=1& 。

最后此篇关于Github标星7.9K！程序员专属的命名宝典来了的文章就讲到这里了,如果你想了解更多关于Github标星7.9K！程序员专属的命名宝典来了的内容请搜索CFSDN的文章或继续浏览相关文章，希望大家以后支持我的博客！ 。

25 4 0
文章推荐： 升级 Vue3 大幅提升开发运行效率
文章推荐： 解析Python中的生成器及其与迭代器的差异
文章推荐： 这7个程序员在线工具，用过一半算你优秀
文章推荐： Python判断列表是否已排序的各种方法及其性能分析
qq735679552
个人简介

我是一名优秀的程序员,十分优秀！

滴滴打车优惠券免费领取
滴滴打车优惠券
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com