C++代码规范(持续更新)

细节:

1.一般双目运算符前后加空格
2.for循环中++i而不要用i++
3.==比较时变量写在右侧,常量写在左侧
4.函数、变量名采用驼峰命名
5.每行缩进4个空格或等长Tab
6.多条语句不要写在一行
7.变量和函数明要具有足够的辨识度以便查找,但是又不能太长,可以用单词缩写组成。
8.采用静态代码检查工具检查代码
9.未完成的代码段用“//TODO”注释
10.析构函数一般定义为虚函数

注释:

1.头文件顶部写版本、日期、人员等描述信息
2.函数声明上方加注释,推荐使用Qtcreator中的快捷添加方式

提交:

1.提交代码时描述信息要分类、每一项用方括号加类型作为前缀,例如:

1.【新增】XXX

2.【bug修正】XXX

2.初级开发人员不直接合并代码到主分支,而是提交合并申请,由高级开发人员进行合并到主分支的操作。

中文与文件编码:

1.c++代码中原则上不出现中文
2.Windows上开发代码,c++代码文件需要保存为utf8+BOM(签名)编码	【Windows】
3.代码中中文应尽量只出现在Qt的QObject派生类成员函数中,且以tr(u8“”)包裹,例如tr(u8"中文")	【Qt】
4.如果中文一定要出现在非QObject类中,应以QString::fromLocal8Bit包裹	【Qt】

IDE扩展

在IDE中通过扩展自动进行代码格式调整,例如空格、换行等

C++部分

基于.clang-format文件,可设置项参考文档
Visual Studio中默认启动,但仅适用于 C# 和 VB.Net,不适用于 C++ 代码,需要下载插件

  1. 在VS中点击 扩展 -> 搜索并安装插件"Format document on Save"
  2. 重启VS
  3. VS2019的clang-format版本为12.0,比如LambdaBodyIndentation: Signature这个键值不支持
  4. VS2022的clang-format版本为15.0

在Qtcreator中的配置方法:

  1. 帮助 -> 关于插件 -> 勾选 c++ 下的 Beautifier 和 ClangFormat 选项 -> 确定
  2. Preferences -> 左侧点击 Beautifier 选项
  3. 右侧"概要"页面 -> 勾选 “Enable auto format on file save”
  4. 右侧"Clang Format"页面 -> Clang format command: 选择本机路径下的 clang-format.exe
  5. 右侧"Clang Format"页面 -> Use predefined style -> 选择 File 选项
  6. (可选)Preferences -> 左侧点击 C++ 选项
  7. (可选)右侧"代码风格"页面 -> Formatting mode -> 选择Full formatting -> 勾选"Format While typing"和"Format edited code on file save"两项
  8. 编辑代码文件后保存 -> 代码自动格式化
QML部分(也包括JS支持)

仅支持基于Qt6.2及以上版本的Qtcreator
功能来源于Qt的qmlformat.exe,Qt提供了源码

  1. 单次使用:工具 -> QML/JS -> 重新格式化文件
  2. 定制:Preferences -> Qt Quick -> 代码风格 -> 可以将默认格式输出 -> 编辑导出的XML文件 -> 导入XML文件。 目前已经存放了一份qml_format.xml文件到代码文件夹下,需要手动导入(只修改了关于Line Length的限制)
  3. 保存时自动应用格式:Preferences -> Qt Quick -> QML/JS Editing -> 勾选Enable auto format on save
CMAKE部分

基于CmakeFormat,IDE中仅有VS Code支持,或通过命令行运行。

  • 0
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
### 回答1: 软件开发标准规范指的是在软件开发过程中要遵守的一套规范和标准。这些规范和标准旨在确保软件开发过程的高质量和高效率。 首先,软件开发标准规范要求开发团队在开发过程中必须有清晰的需求分析和设计阶段。在需求分析阶段,开发团队应该与客户进行深入沟通,确保全面理解客户的需求和预期。在设计阶段,开发团队应该制定详细的系统设计文档,并确保代码的可读性和可维护性。 其次,软件开发标准规范要求开发团队严格遵循编码规范。编码规范包括命名规范代码注释规范代码缩进和格式化规范等。这些规范可以提高代码的可读性,并减少开发中的错误和bug。 另外,软件开发标准规范还要求开发团队使用版本控制工具来管理代码的变更。版本控制工具可以记录代码的修改历史,并且可以方便团队成员之间的协作和沟通。同时,团队成员还应该定期进行代码的review和测试,以确保代码质量。 最后,软件开发标准规范还要求开发团队进行系统的测试和验收。测试包括单元测试、集成测试和系统测试等。通过测试,可以发现和修复软件中的问题和缺陷。验收阶段则是客户对软件进行最终的确认和接受。 总之,软件开发标准规范对于保证软件开发过程的高质量和高效率起着重要的作用。团队成员应该严格遵守这些规范,并不断提高自身的技术能力和软件开发水平。 ### 回答2: C 软件开发标准规范是指在软件开发过程中所遵循的一系列标准和规范。它的目的是确保软件开发的质量和可靠性,并提高软件开发过程的效率。 首先,C 软件开发标准规范包括代码编写规范。这些规范定义了代码的命名规则、格式要求以及注释的使用方法。通过统一的代码风格,可以提高代码的可读性和可维护性。 其次,C 软件开发标准规范还包括软件设计规范。这些规范指导开发人员进行软件系统的设计,包括模块划分、接口设计等方面。通过良好的软件设计,可以降低系统的复杂性,提高系统的可扩展性和可重用性。 此外,C 软件开发标准规范还关注软件测试和质量保证。它定义了测试用例编写的规范,以及测试覆盖率和质量指标的要求。通过规范的测试流程和验证标准,可以提高软件的稳定性和可靠性。 最后,C 软件开发标准规范还涉及项目管理和文档编写方面。它定义了开发团队的组织结构、项目计划和沟通流程等,以及各类文档的编写规范。通过规范的项目管理和文档编写,可以保证开发过程的协调性和可追溯性。 总之,C 软件开发标准规范对于软件开发过程起到了指导作用,可以提高软件的质量和开发效率。开发人员应严格按照规范进行开发,并不断学习更新的标准和规范,以保持与行业最佳实践的接轨。 ### 回答3: C 软件开发标准规范是一份技术文档,为了确保软件开发过程的质量和效率,规范了开发团队在软件开发生命周期各个阶段的工作流程和标准。 在项目准备阶段,C 软件开发标准规范要求团队需要明确项目目标、需求和约束,制定进度计划和项目评估。这有助于确保项目的可行性和正确性,并为后续的开发工作奠定基础。 在需求分析阶段,C 软件开发标准规范要求团队进行详细的系统需求分析和规范编写。这包括用户需求调研、功能设计、数据流程图等工作,确保开发的软件满足用户需求和业务流程。 在系统设计阶段,C 软件开发标准规范要求团队进行系统结构设计和模块设计。这包括系统架构设计、数据库设计、模块接口设计等工作。通过合理的设计,提高软件的可维护性和扩展性。 在编码阶段,C 软件开发标准规范要求团队采用统一的编码规范,保证代码的可读性和可维护性。同时,规范还要求进行代码审查和单元测试,以及使用版本控制工具管理代码。 在测试阶段,C 软件开发标准规范要求团队进行系统测试和验收测试。这包括功能测试、性能测试、安全测试等工作,保证软件的质量和稳定性。 最后,在项目交付和维护阶段,C 软件开发标准规范要求团队进行用户培训和文档编写,以及进行持续的维护和技术支持。 总的来说,C 软件开发标准规范对软件开发进行了全方位的规范,并确保了软件开发过程的质量、效率和可维护性。这有助于提高团队的协作效率,减少错误和风险,提高软件的稳定性和用户满意度。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值