首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

确切地说,“上下文”命名约定是什么

上下文命名约定是一种规范,用于在编程中给变量、函数、类等命名时,使其能够清晰地表达其含义和作用。它是一种约定俗成的命名规则,旨在提高代码的可读性和可维护性。

上下文命名约定可以分为以下几个方面:

  1. 变量命名:变量名应该具有描述性,能够清晰地表达其含义和用途。通常使用驼峰命名法(camel case)或下划线命名法(snake case)。例如,驼峰命名法:firstName;下划线命名法:first_name。
  2. 函数命名:函数名应该能够清晰地表达其功能和作用。通常使用动词开头的驼峰命名法。例如,getUserInfo。
  3. 类命名:类名应该具有描述性,能够清晰地表达其代表的对象或概念。通常使用名词开头的驼峰命名法。例如,UserInfo。
  4. 常量命名:常量名通常使用全大写字母,多个单词之间使用下划线分隔。例如,MAX_VALUE。
  5. 文件命名:文件名应该能够清晰地表达其所包含的内容。通常使用小写字母,多个单词之间使用下划线分隔。例如,user_info.js。

上下文命名约定的优势在于:

  1. 提高代码的可读性:遵循统一的命名约定,可以使代码更易于理解和阅读,减少他人阅读代码时的困惑。
  2. 提高代码的可维护性:清晰的命名可以使代码更易于维护和修改,减少因为命名不清晰而引发的错误。
  3. 促进团队协作:统一的命名约定可以使团队成员之间更容易理解彼此的代码,提高团队协作效率。

上下文命名约定在各类编程语言和开发过程中都适用,无论是前端开发、后端开发还是移动开发等领域都需要遵循良好的命名约定。

腾讯云相关产品和产品介绍链接地址:

请注意,以上链接仅供参考,具体产品选择应根据实际需求进行评估和决策。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

是什么使代码 “Swifty”? —— Safe

例如,许多Swift开发人员都记得从Swift 2到Swift 3的转换是语法方面的重大更改,但是这些更改中的大多数并不是真正的语法更改——它们是基于新集合对标准库API的更改命名约定。...本周,让我们仔细研究一下Swift的核心约定,以试图回答是什么真正使代码“ Swifty ” 的问题。 ?...毕竟,尽管Swift的各种API,约定和语言功能会随着时间而变化,但它的基本目标基本保持不变——因此,如果我们能够以符合这些目标的方式编写自己的代码,那么我们将有更好的机会在任何给定的Swift上下文中使我们的代码看起来自然而清晰...Preloadable(如果是,则预加载该资源)这一事实可以有点奇怪。...—— Expressive 介绍了如何使用表达性命名和API设计传达我们的代码意图

87010
  • 我终于把Python中下划线的含义弄清楚了(憋了很久了)

    其中的某些含义仅是约定俗成的内容,旨在作为对程序员的提示-某些含义是由Python解释器实施的。 如果想知道“ Python变量和方法名称中的下划线和下划线分别是什么意思?”...pass 总之,惯例使用单个尾划线(后缀)来避免与Python关键字的命名冲突。在PEP 8中解释了这种约定。...双首下划线: __var 到目前为止,我们所讨论的命名模式仅从约定约定中获得它们的含义。对于以双下划线开头的Python类属性(变量和方法),情况略有不同。...这证明了名称混乱并不是特定与类属性绑定在一起的。它适用于在类上下文中以两个下划线开头的任何名称。...单尾划线 var_ 按照惯例使用,以避免与Python关键字命名冲突。 双领先下划线 __var 在类上下文中使用时触发名称修改。由Python解释器实施。

    10.5K21

    这8点能教你如何更好阅读代码

    你可以访问丰富的元数据,这将使你理解的不仅仅是代码,还包括上下文,都会容易很多。我会假设你使用 Git ,但是如果你使用 SVN ,那么这个想法也是同样适用的。...此命令将打印提交消息,因此,如果要执行类似搜索提交消息中引用 someFunction 的提交,请勿忘记使用 grep 命令:git log | grep someFunction -C 3(-C 3将显示匹配到的上下文三行内容...近期更改的一大堆代码可能会告诉您最近几周开发团队面临的一些挑战,也许他们已经推出了一个新的库,也许他们一直在努力配置一个运行不太好的库,或者也许只需要定期更新的样板代码。...当然,这包括表面的东西,如命名约定、间距约定和大括号放置,但这些都也包括代码约定中。 一般的抽象层次是什么?如果它是具有很多层次的高度抽象代码,那么你应该也希望编写同样的代码。...如果你挖掘足够多的代码历史版本,你可以找到一个确切的时间点,选择其中一个开发人员一段代码查看。查看以前这段代码原来看起来是怎么样,以后怎么样?在编写代码时,尝试遵循共同的约定

    74380

    Python 中5种下划线的含义都是什么

    有一些含义仅仅是依照约定,被视作提示,而有一些含义是由Python解释器严格执行的。你们是否想知道Python变量和方法名称中各种单下划线和双下划线的含义是什么?...:_ 本文总结5种不同的下划线命名约定及其含义,可让你亲身体验它们的行为,文末附有一个简短的“速查表”总结用法。...与通配符导入不同,常规导入不受前导单个下划线命名约定的影响: 3 小结 如果遵循PEP8推荐,避免通配符导入,只需要记住: 单个下划线是一个Python命名约定,表示这个名称是供内部使用的。...2 示例 为避免冲突,你可以附加一个下划线来解决命名冲突: 3 小结 总之,单个末尾下划线(后缀)是一个约定,用来避免与Python关键字产生命名冲突。PEP8解释了这个约定。...就像我之前过的,在这种情况下,前导下划线仅仅是一个约定。 给程序员一个提示而已。 然而,对于self.__baz而言,情况看起来有点不同。

    1.3K40

    Python中下划线的5种含义

    有一些含义仅仅是依照约定,被视作是对程序员的提示 - 而有一些含义是由Python解释器严格执行的。 如果你想知道“Python变量和方法名称中单下划线和双下划线的含义是什么?”...:_ 在文章结尾处,你可以找到一个简短的“速查表”,总结了五种不同的下划线命名约定及其含义,以及一个简短的视频教程,可让你亲身体验它们的行为。...单前导下划线 _var 当涉及到变量和方法名称时,单个下划线前缀有一个约定俗成的含义。 它是对程序员的一个提示 - 意味着Python社区一致认为它应该是什么意思,但程序的行为不受影响。...pass 总之,单个末尾下划线(后缀)是一个约定,用来避免与Python关键字产生命名冲突。 PEP 8解释了这个约定。 3....就像我之前过的,在这种情况下,前导下划线仅仅是一个约定。 给程序员一个提示而已。 然而,对于self.__baz而言,情况看起来有点不同。

    1.5K70

    这个 6500 Star 的手册帮你解决命名难的问题

    命名是一件很困难的事情,naming-cheatsheet 是一个命名备忘录,记录一些常见的规范约定,试图让命名变得更容易。...命名约定 选择一种命名约定风格,并严格遵守它,可以是 camelCase、ParscalCase、snake_case,或者是其他任何的风格,最重要的是要保持一致。...、直观并且具有描述性: Short:简短,避免输入太长; Intuitive:直观,命名必须自然阅读,并且尽可能接近自然语言; Descriptive:以最有效的方式反映其作用或目的。.../* Bad */ const onItmClk = () => {} /* Good */ const onItemClick = () => {} 避免上下文重复 命名不应与定义命名上下文重复,...如果不降低命名的可读性,请务必从命名中删除该上下文

    40120

    C# WPF MVVM开发框架Caliburn.Micro 关于Conventions⑧

    这就是为什么CM的约定是完全可定制的,如果不需要,甚至可以完全关闭。如果您要使用约定,并且由于它们在默认情况下处于启用状态,那么最好了解这些约定是什么以及它们是如何工作的。这就是本文的主题。...为此,CM使用一个简单的命名模式来查找UserControl1,它应该绑定到ViewModel并显示它。那么,这种模式是什么?...通过从末尾删除单词“View”并附加上下文,此转换有效假设您拥有用于不同视图的文件夹(命名空间)。...我们在这个场景中使用了与视图位置类似的命名约定。这由ViewModelLocator.LocateForViewType处理。...但是,了解这些约定是什么以及在整个框架中如何使用它们是很重要的。在本文的最底部是一个代码列表,它显示了如何开箱即用地配置所有元素。

    2.8K20

    12 种使用 Vue 的最佳做法

    在 JS 中,驼峰式声明是标准,在HTML中,是短横线命名。因此,我们相应使用它们。 幸运的是,Vue 已经提供了驼峰式声明和短横线命名之间转换,因此除了实际声明它们之外,我们不必担心任何事情。...在设计大型项目时,很容易忘记用于props的确切格式、类型和其他约定。如果你在一个更大的开发团队中,你的同事不会读心术,所以你要清楚告诉他们如何使用你的组件。...BaseButton.vue BaseIcon.vue BaseHeading.vue 该命名约定的目的是使基本组件按字母顺序分组在文件系统中。...另外,通过使用webpack导入功能,我们可以搜索与命名约定模式匹配的组件,并将所有组件自动导入为Vue项目中的全局变量。...9.单实例组件命名应该带有前缀 `The` 与基本组件类似,单实例组件(每个页面使用一次,不接受任何prop)应该有自己的命名约定

    1.1K10

    Python中 5 种不同的下划线含义你都知道吗?

    :_ 在文章结尾处,你可以找到一个简短的速查表,总结了五种不同的下划线命名约定及其含义,让我们马上开始!...单前导下划线 _var 当涉及到变量和方法名称时,单个下划线前缀有一个约定俗成的含义。它是对程序员的一个提示:意味着Python社区一致认为它应该是什么意思,但程序的行为不受影响。...如果你遵循PEP 8推荐,避免通配符导入,那么你真正需要记住的只有这个: “单个下划线是一个Python命名约定,表示这个名称是供内部使用的。...pass 总之,单个末尾下划线(后缀)是一个约定,用来避免与Python关键字产生命名冲突。PEP 8解释了这个约定。 3....就像我之前过的,在这种情况下,前导下划线仅仅是一个约定。给程序员一个提示而已。 然而,对于self.__baz而言,情况看起来有点不同。当你在该列表中搜索__baz时,你会看不到有这个名字的变量。

    87231

    掌握 Python 中下划线的 5 个潜规则

    :_ 在文章结尾处,你可以找到一个简短的速查表,总结了五种不同的下划线命名约定及其含义,让我们马上开始!...单前导下划线 _var 当涉及到变量和方法名称时,单个下划线前缀有一个约定俗成的含义。它是对程序员的一个提示:意味着Python社区一致认为它应该是什么意思,但程序的行为不受影响。...如果你遵循PEP 8推荐,避免通配符导入,那么你真正需要记住的只有这个: “单个下划线是一个Python命名约定,表示这个名称是供内部使用的。...pass 总之,单个末尾下划线(后缀)是一个约定,用来避免与Python关键字产生命名冲突。PEP 8解释了这个约定。 3....就像我之前过的,在这种情况下,前导下划线仅仅是一个约定。给程序员一个提示而已。 然而,对于self.__baz而言,情况看起来有点不同。当你在该列表中搜索__baz时,你会看不到有这个名字的变量。

    52820

    C# WPF MVVM开发框架Caliburn.Micro关于关于Actions⑤

    01 关于Actions 为了开始我们的研究,我们将以简单的“Hello”示例为例,看看当我们显式创建操作而不是使用约定时,它是什么样子。...通过这些功能,您可以方便访问常见的上下文信息: $eventArgs 将EventArgs或输入参数传递给操作。注意:对于保护方法,这将是null,因为触发器实际上没有发生。...注意:使用特殊值,如$this或命名元素 如果不指定属性,CM将使用默认属性,该属性由特定控件约定指定。...我们将在将来更多讨论约定,但是您应该很高兴知道这些约定不区分大小写,甚至可以检测前面提到的“特殊”值。...你总是可以直截了当地粗话。

    2.1K20

    C语言(数据类型)

    不卖关子了,更帅的理解如下:“所谓类型,是我们在使用一块内存之前,跟系统事先说好的一个约定”。 对,类型是一个约定。...内存也一样,好的用来存放整型,那么系统就会严格遵守你们的约定,将这块内存的每一位都对应解释为 2 的次幂,然后进行累加。而你却可以瞒着系统,将其他任意数据“塞”到这块内存中。...此例旨在告诉你,甭管是什么变量,都只是一块内存,里面都是一大串101010110101……序列而已,语法上我们可以随意操纵这些内存,以及里面的内容,但是逻辑上我们必须使得他们有意义,所以还必须考虑每块内存的本职工作...,因为目标类型未定,就相当于目标的大小尺寸无从得知,其内存解释方式更加无从谈起,因此当然就无法对其进行任何运算(包括加减法和解引用运算),因此 void 型指针的在使用之前,必须将其转换为一个目标类型确切的指针...就是跟系统(物业):嘿哥们!原先我们好只办公(void型指针)的,现在我们有点特殊情况,临时改造成厨房(int型指针),请你知悉并配合!

    1.7K50

    命名在编程中的重要性

    来表示获取到的用户,而不是像usersWithSpecifiedFirstAndLastName或fetchedUsers这样更长的名称:不需要使用更长的名称,因为这个变量作用域非常局部、生命周期很短,并且周围上下文足以清楚说明它的含义...它不会假设读者不太可能拥有的上下文或知识。此外,上下文至关重要:你不能在没有读取的上下文的情况下评估名字。...坚持在代码库中使用的约定。...每次命名的简单技巧如果你在命名的时候遇到困难,做以下事情:在函数/变量上方写一个注释,用人话描述它是什么,就像你在向同事描述一样。可能是一句话,也可能是多句话。...以命名为重点的代码审查一旦你开始深思熟虑命名,你会看到它是如何改变你的代码审查过程的:焦点从查看实现细节转移到首先查看名称。当我在进行代码审查时,我会有一个主要的思考:“这个名字清晰吗?”。

    4810

    Python下划线5种含义代码实例解析

    单前导下划线:_var 当涉及到变量和方法名称时,单个下划线前缀有一个约定俗成的含义。 它是对程序员的一个提示 – 意味着Python社区一致认为它应该是什么意思,但程序的行为不受影响。...这就像有人提出了一个小小的下划线警告标志,: “嘿,这不是真的要成为类的公共接口的一部分。不去管它就好。“ 单末尾下划线 var_ 有时候,一个变量的最合适的名称已经被一个关键字所占用。...pass 总之,单个末尾下划线(后缀)是一个约定,用来避免与Python关键字产生命名冲突。 PEP 8解释了这个约定。...双前导下划线 __var 到目前为止,我们所涉及的所有命名模式的含义,来自于已达成共识的约定。 而对于以双下划线开头的Python类的属性(包括变量和方法),情况就有点不同了。...就像我之前过的,在这种情况下,前导下划线仅仅是一个约定。 给程序员一个提示而已。 然而,对于self.__baz而言,情况看起来有点不同。

    69020

    【前沿技术】API设计原则

    一个骨灰级资深的同事跟我过,任何在成长的代码库,至少半年到一年就要重构一次,否则失去的不仅是活力,更失去了可维护性与可用性。...API 语义和文档 比如传值 -1 的含义是什么?如果 API 文档不像 http status codes 一样健全,建议通过枚举的方式增加可读性。 命名的艺术 不要使用缩写,保持一致性。...类命名以功能分组作为后缀,比零散命名更易懂。 函数命名要体现出是否包含副作用,参数过多时以对象作为传参,布尔参数改为枚举类型,或者分解为两个语义化 API。 3 精读 以下精读是对原文观点的补充。...类型,静态检查阶段就禁止了对值的直接修改,同时因为有这个关键字的约束,在函数体内也约定不要通过引用浅拷贝修改它的值。...不要重复局部命名 class User { // good setName() {} // bad setUserName() {} } 在有上下文环境的调用中,减少不必要的描述可以提高

    7000

    如何使用CSS命名规范提高您的编码效率

    通过阅读本文,读者应该清楚了解CSS命名规范及其好处,并熟悉不同的样式命名约定。...可维护性和可扩展性:遵循命名约定后,CSS元素可以轻松进行修改或修复错误。可以对现有代码进行新功能或改进,而不会引入错误。...上下文命名:在为类分配名称之前,请考虑元素的使用环境以及其提供的功能和特性。这有助于选择最合适的元素名称,并避免在开发过程中出现命名冲突。...项目开发中的命名一致性:在开发之前,建立一个命名约定和指南,以确保所有团队成员都能一致遵循它们,提供一个易于维护和协调的代码库。 避免使用泛泛而谈的名称:类名应该反映其所分配给的元素的意图和含义。...这有助于提供有关类名的上下文,并避免命名冲突,因为前缀与其他前缀是唯一的,即使它们可能具有相似的名称。

    37030
    领券