`
zhuyx808
  • 浏览: 122925 次
  • 性别: Icon_minigender_1
  • 来自: 快来看~天上米有灰机
社区版块
存档分类
最新评论

变量名命名、注释的重要性

    博客分类:
  • JAVA
 
阅读更多
忙中偷闲无意翻到以前写的代码,侦测数据库连接池情况。我先不说具体代码的优雅情况,就上面密密麻麻的代码还有几个获取配置文件变量的东东就看的我自己头大,意思完全不明(呵呵有点夸张了),而且注释写的超级简单,又看看配置文件,又读读代码,意思才慢慢清楚了,这时才想起来以前老师教我们变量命名,代码详细注释的重要性……
分享到:
评论

相关推荐

    变量的命名约定

    #### 一、命名约定的重要性 变量的命名约定是编程规范的一部分,它定义了如何为变量选择有意义且一致的名字。遵循一定的命名规则有助于: 1. **增强代码的可读性**:清晰的变量名可以立即传达其用途或所存储数据的...

    C#命名与注释规范——个人版

    综上所述,C#中的命名规范与注释规范对于提高代码质量和可维护性具有重要作用。通过遵循上述指南,开发者可以编写出更加清晰、易读且易于维护的代码。此外,良好的编码习惯也有助于团队协作,确保项目顺利进行。希望...

    Web前端开发技术-变量的命名规范.pptx

    1. **组成**:变量名可以由字母(包括Unicode字符)、数字、下划线(_)和美元符号($)组成。例如,`myVariable1`、`helloWorld`或`_tempValue`都是合法的变量名。 2. **大小写**:JavaScript是区分大小写的,因此...

    MFC.rar_变量命名

    9. **注释和文档**:尽管好的变量名可以传达很多信息,但添加适当的注释和文档可以进一步提升代码的可理解性。对于重要的变量,可以说明其用途、初始值或特殊情况。 10. **命名空间**:在大型项目中,使用命名空间...

    Python的变量、常量、注释

    在Python编程中,变量、常量和注释是三个非常基础且重要的...在编写代码的过程中,应当养成良好的编程习惯,包括使用有意义的变量名和常量名,以及在代码的关键部分添加注释,为代码的长期维护和团队协作打下坚实基础。

    通用VBA程序变量命名规则

    10. **注释**:即使有了良好的变量名,也应为复杂或重要的变量添加注释,解释其作用和计算方式。 通过遵循这些规则,你可以创建出结构清晰、易于理解的VBA代码。`VBA变量命名规则.xls`文件可能包含了更多具体示例和...

    c语言匈牙利试变量命名法则

    这种命名法的核心思想是在变量名的前面添加一个或多个小写字母,用来描述变量的类型或者用途,以增强代码的可读性和一致性。 在匈牙利命名法中,通常会根据变量的类型来选择不同的前缀: - `n` 用于表示整型变量...

    VC变量命名规范(有例子)

    3. **匈牙利命名法**:这是一种常见的命名约定,通过在变量名前面加上一个或多个字符来表示该变量的类型或者用途。例如,`p` 表示指针,`sz` 表示字符串等。 4. **意义明确**:变量名应尽可能反映其实际用途或含义,...

    变量名的力量(部分)

    11.3节探讨了命名规则的重要性。规则的存在是为了保持代码一致性,减少理解成本。何时采用命名规则取决于项目规模、团队规范和代码库的复杂性。在大型项目中,统一的命名规则是必要的,而小型项目则可能更加灵活。...

    java命名规范以及注释规范

    Java编程语言有着严格的命名规范和注释规则,这对于提高代码的可读性、可维护性和团队协作至关重要。以下是对这些规范的详细说明: 1. **包名命名规范**: - 包名全由小写字母组成,可以包含少量数字。 - Java...

    js命名规范与注释规范.md

    变量名推荐使用小驼峰式命名法,若包含多个单词,则首单词首字母小写,后续单词首字母大写。为了增加语义明确性,变量名可以使用前缀,其中形容词或名词作为前缀,以便于区分变量和函数。 **示例**: ```javascript...

    程序开发和设计命名规范.doc

    - **长度与描述性**:变量名应尽量简洁且具有描述性。 - **避免数字编号**:尽量避免使用数字编号作为变量名的一部分,除非确实需要。 - **声明变量**:建议在使用变量前先声明变量。 示例: ```php $iNumber = 0; ...

    如何给变量命名

    4. **避免匈牙利命名法**:尽管在过去,匈牙利命名法(将数据类型嵌入变量名中)流行于某些编程环境中,但现代的强类型语言已不再需要这一做法。这不仅使代码冗长,也降低了可读性。 ```csharp // 正确示例 ...

    超全Unity代码命名规范

    在Unity开发过程中,遵循一套统一的代码命名规范至关重要。它能提高代码的可读性,降低维护成本,便于团队协作。这份"超全Unity代码命名规范"由知名游戏公司炫睛科技提供,涵盖注释、变量、方法等多个方面的命名规则...

    C语言变量命名规则.pdf

    4. **匈牙利命名法**:这是一种常见的变量命名约定,变量名由类型标识符和变量含义组成。例如,布尔型变量通常以`b`开头,如`bIsParent`;整型变量以`n`开头,如`nStepCount`;字符型以`c`开头,如`cCount`。对于非...

    JAVA编程命名规范Java-开发命名规范

    JAVA命名规范是JAVA开发中非常重要的一部分,它规定了JAVA程序中的命名规则,以提高代码的可读性和可维护性。该规范涵盖了JAVA中的各种命名规则,包括包命名、类命名、方法命名、参数命名、变量命名和常量命名等。 ...

    C#代码命名规范

    方法命名需要遵守一定的规范,即首字母必须大写,如果该变量名有多个单词组成,后面的单词首字母大写,单词与单词之间不要使用"_"做连接。单词不要使用名词,要添加注释(包含参数的注释)。例如:bool CheckLogin...

    IOS开发编码及命名规范

    * 变量名应使用驼峰命名法,例如:userName * 变量名不得使用下划线 * 变量名不得超过 30 个字符 常量 以下是常量命名的规则: * 常量名应使用大写字母和下划线,例如:MAX_WIDTH * 常量名不得超过 30 个字符 类 ...

    VB语言编程命名规范规则

    在VB(Visual Basic)语言编程中,遵循良好的命名规范至关重要,因为它可以提高代码的可读性、可维护性和团队协作效率。以下是对VB语言编程命名规范的一些详细解释: 1. **变量命名**: - 变量名应简洁且具有描述...

Global site tag (gtag.js) - Google Analytics