我的C++编程规范
一、命名规范
1.变量名:使用有意义的英文单词,采用小驼峰命名法(camelCase)。
正确示例:studentName, totalScore
2.常量名:全部大写,单词间用下划线分隔(UPPER_SNAKE_CASE)。
3.函数/方法名:小驼峰命名法,动词开头,体现功能。
4.类名:大驼峰命名法(PascalCase)。
示例:StudentManager, CourseScheduler
5.文件名:与类名保持一致(Java)或使用小写加下划线(C++/Python)。
二、代码格式规范
1.缩进:统一使用 4个空格 缩进,不使用Tab键(避免跨平台错乱)。
2.大括号:左大括号 { 不换行,右大括号 } 单独一行。
3.空行:方法之间空一行。逻辑段落之间可适当空行,增强可读性。
4.每行长度:尽量不超过80-100个字符,过长时合理换行。
三、注释规范
1.类/方法注释:使用文档注释(如Java的/** */),说明功能、参数、返回值。
2.关键逻辑注释:复杂算法或特殊处理需加单行注释 //。
3.避免无用注释:不要注释“显而易见”的代码。
注释语言:课程作业中建议使用中文注释,便于理解。
四、结构与逻辑规范
1.单一职责:一个函数只做一件事,避免“万能函数”。
2.避免硬编码:魔法数字应定义为常量。
3.异常处理:使用try-catch处理可能出错的操作,不忽略异常。
4.资源释放:文件、网络连接等使用后及时关闭。
五、语言特定建议
Java:
1.每个类放在单独文件中,文件名与类名一致。
2.使用private修饰成员变量,提供getter/setter。
使用ArrayList、HashMap等集合类时注意泛型
浙公网安备 33010602011771号