文章目录
前言
编程语言的命名规范通常是为了提高代码的可读性和可维护性。
提示:如有异议可以在评论区友善交流或者直接私信我
雷同纯属巧合
以下是本篇文章正文内容,下面案例仅供参考
省流版本:
变量名的最低规范
1.变量名中只
能出现字母
数字
下划线
(现在也有中文但是会很low)
2.变量的第一个字符不能是
数字
3.不要混用
命名原则(看多了真的很恶心)
变量名常用的两种规范
1.驼峰命名规范:
变量名是由一堆单词组成的,第一个单词的首字母小写,其余字母的首字母大写
Eg. myWifeName = 'saly'`
2.类ruby命名规范:
变量名由一堆单词租车给,单词之间用下划线连接,单词首字母小写
Eg. my_wife_name = 'saly'
精讲内容
以下的内容可以写的代码看起来更加的整洁和规范,规定大致方向如此
1.变量命名
小写字母加下划线(snake_case):
通常用于全局变量和函数名,例如 my_variable。
驼峰命名法(camelCase):
常用于局部变量和函数名,例如 myVariable。
大驼峰命名法(PascalCase):
常用于类名和接口名,例如 MyClass。
2.常量命名
全大写加下划线:常量通常使用全大写字母并用下划线分隔,
例如 MAX_VALUE 或 PI_VALUE。
3. 函数和方法命名
通常使用动词或动词短语开头,表明函数的作用,
例如 calculateSum()、fetchData()。
4. 类和接口命名
类名和接口名通常使用大驼峰命名法,表明是一个对象或类型的定义,
例如 Employee 或 IDatabase。
5. 文件和目录命名
文件名通常与其内容相关,使用小写字母并用下划线分隔,或者使用驼峰命名法。
例如,data_processor.py 或 DataProcessor.py。
6. 命名约定
避免使用缩写:尽量使用完整的词汇来提高可读性,除非缩写广为人知。
避免使用单字母命名:除非在很小的范围内,例如循环计数器(i, j)。
命名具有描述性:变量和函数的名称应该能反映其用途。
7. 语言特定的命名规范
各种编程语言可能有自己的命名规范,
例如 Java 的命名规范、Python 的命名约定等,
遵循这些特定语言的指南可以提高代码的一致性。
8. 文档和注释
在复杂的代码中,使用文档字符串或注释来解释变量和函数的用途,进一步提高代码的可读性。
总结
遵循这些代码规范可以帮助不仅可以让程序员的代码更加规范还可以让团队之间更好地理解代码,提高协作效率。