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

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

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

相关推荐

    C#代码命名规范

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

    系统开发二部嵌入式C语言编程规范.pdf

    例如,整型变量名可以加上“_i”后缀,浮点型变量名可以加上“_f”后缀。 宏的命名规则 宏的命名规则与变量命名规则类似,但需要加上大写字母开头,例如“MAX_VALUE”或“MIN_VALUE”。 函数的命名规则 函数的...

    高质量C语言编程思想PDF

    变量名的长度通常在8到16个字符之间,变量名的格式通常是小驼峰命名法或大驼峰命名法,变量名的意义是指变量的用途和作用。 函数设计 函数设计是指函数的设计原则和方法,包括函数的命名、函数的参数、函数的...

    软件编码规范方案.doc

    变量命名是软件编码规范的重要部分,好的变量命名可以提高代码的可读性和可维护性。变量命名应该遵循以下原则: * 变量名应该是唯一的 * 变量名应该 Clearly 表示变量的内容 * 变量名应该使用英文简写 例如,一个...

    代码开发规范.doc 说明

    例如,变量名和函数名不能使用保留字,而类名和命名空间名则需要遵守特定的命名规则。 2.4 命名空间命名 命名空间命名规定了命名空间的命名规则,包括公司名、项目名和模块名等。 2.5 类、结构和接口命名 类、...

    软件开发代码规范(C#版).doc

    例如,变量名可以命名为"UserName"、"OrderAmount"等。 控件命名规范中,建议使用与控件类型相关的前缀,例如"txt"、"lbl"、"btn"等。 常量命名规范中,建议使用全大写字母,例如"MAX_VALUE"、"MIN_VALUE"等。 ...

    java编码规范华为.doc

    * 使用 meaningful 的变量名和方法名 * 避免使用magic number * 使用适当的注释来解释代码的逻辑 5. 注释规范 该文档提供了详细的注释规范,包括注释的格式、内容和位置等,旨在确保代码的可读性和可维护性。 5.1...

    C++编码规范.pdf

    C++编码规范是一个重要的编程标准,旨在提高代码的可读性、可维护性和可重用性。下面是该规范的详细解释: 1. 类成员函数命名 类成员函数的命名规则是使用完整的英文描述,函数名的第一个单词通常是一个动词,如...

    C++开发技术标准20201102.docx

    * 命名惯例:使用有意义的变量名、函数名和类名,遵守驼峰命名法或下划线命名法。 * 代码缩进:使用空格或制表符来缩进代码,提高代码的可读性。 * 代码注释:使用注释来解释代码的逻辑和意图,提高代码的可读性和可...

    (完整word)软件过程源代码编写规范.doc

    * 变量名和函数名必须使用驼峰命名法(Camel Case)。 * 变量名和函数名的长度不能超过32个字符。 * 变量名和函数名不能使用特殊字符和中文字符。 3.3 VB命名规范 * 变量名和函数名必须使用大写字母和数字,字母和...

    C++C代码审查表.pdf

    * 在定义变量(或参数)时,是否将修饰符* 和&紧靠变量名? * 注释是否清晰并且必要? * 注释是否有错误或者可能导致误解? * 类结构的 public, protected, private 顺序是否在所有的程序中保持一致? 命名规则...

    javascript编程规范-修订版.docx

    文件命名标准是编程规范的重要组成部分,良好的文件命名标准可以提高代码的可读性和维护性。JavaScript 文件命名标准主要包括以下几个方面: 3.1 文件名 * 使用小写字母和数字组成文件名 * 文件名应该清晰、简洁、...

    Java规范Java规范Java规范Java规范

    在命名风格中,手册强调了命名规则的重要性,例如,类名、方法名、变量名的命名规则。命名风格的好坏直接影响代码的可读性和可维护性。 常量定义 常量定义是编程规约的重要组成部分。手册规定了常量定义的规则,...

    C语言编码规范.pdf

    * 变量名应使用小写字母,且不超过16个字符。 * 变量名应与其含义相关。 * 函数名应使用大写字母开头,且不超过16个字符。 * 宏定义应使用大写字母,且不超过16个字符。 编程风格 编程风格对代码的可读性和可维护...

    LabVIEW软件编程规范标准.doc

    在定义时加入注释说明,变量名=变量类型+变量的英文意思(或缩写)。 三、其他规则 在LabVIEW 软件编程规范标准中,还有其他一些规则,如注释规、程序健壮性、可移植性、错误处理以及软件的模块化规等。这些规则都...

    python编程规范.pdf

    * 变量名、函数名、模块名使用小写字母,单词之间使用下划线分隔。 * 类名使用大写字母,单词之间使用下划线分隔。 * 常量名使用大写字母,单词之间使用下划线分隔。 五、错误处理 错误处理是 Python 代码中非常...

    嵌入式软件编程规范方案.doc

    需要遵守一定的命名规则,例如,变量名应该使用小写字母和下划线,函数名应该使用大写字母开头等。 5. 可读性 可读性是编程中非常重要的一个方面。需要遵守一定的可读性规则,例如,代码应该使用空格和换行符来...

    通达信DLL函数编程规范.doc

    命名约定是指函数名、变量名和常量名的命名规则。函数名应以小写字母开头,变量名和常量名应以大写字母开头。 其次,开发者需要遵守通达信DLL函数的编程风格。编程风格是指代码的组织结构和格式。代码应以函数为...

    C++程序书写规范标准.doc

    变量名、参数名、缩略语用于表示变量和参数,提高代码的可读性和可维护性。 4. 函数名 函数名用于定义函数,提高代码的可读性和可维护性。 5. 匈牙利命名法 匈牙利命名法用于表示变量和函数,提高代码的可读性...

    软件工程实践编程实用全套PPT.ppt

    符号名的命名即标识符,包括模块名、变量名、常量名、标号名、子程序名、数数据区名和缓冲区名等。符号名应能反映它所代表的实际东西,应有一定的实际意义。 七、注释的重要性 注释是程序员与日后程序读者之间重要...

Global site tag (gtag.js) - Google Analytics