CMMI5：编码时须参考哪些文件与规范？你采用了什么编程语言？公司是否对这些语言的编码规范做了规定？编程活动在什么时候开始启动？你编写的程序是如何知道满足设计的？如何确保代码的质量？编码验证方式?

本文链接：https://blog.youkuaiyun.com/sunyuhua_keyboard/article/details/145747439

编码时须参考哪些文件与规范

项目需求文档：明确项目要实现的功能、性能要求、用户交互等方面的详细需求，确保编写的代码能满足项目预期目标。例如，开发一个电商网站，需求文档会规定商品展示、下单流程、用户注册登录等功能细节，编码时需依据这些来实现相应模块。
设计文档：包括软件架构设计、数据库设计、模块划分及接口设计等内容。它为编码提供了整体框架和具体模块的实现思路，比如架构设计文档会确定系统采用的是分层架构还是微服务架构等，编码要按照此架构来组织代码结构。
编码规范文档：公司通常会制定统一的编码规范，涵盖命名规范（如变量、函数、类的命名规则）、代码格式规范（缩进、换行、空格使用等）、注释规范等方面。不同编程语言也有各自的官方编码规范或业界公认的良好实践规范可参考。以Java为例，Oracle官方有Java编码规范建议，同时像Google等公司也发布过适用于Java开发的详细编码规范供参考。

采用了什么编程语言

这取决于项目的具体需求和特点。常见的编程语言有：

Java：具有跨平台性、面向对象特性、丰富的类库等优点，广泛应用于企业级应用开发、安卓应用开发等领域。例如，大型电商平台、金融业务系统等很多采用Java开发。
Python：语法简洁、代码编写高效，在数据科学、人工智能、脚本编写、自动化测试等方面应用广泛。比如进行数据分析、机器学习模型开发时，Python是常用语言。
C++：性能高效，适用于对运行速度和资源利用要求较高的场景，如游戏开发、操作系统开发、嵌入式系统开发等。像一些大型3D游戏引擎底层多采用C++编写。
JavaScript：主要用于前端网页开发，实现网页的交互效果、动态内容展示等，也可用于后端开发（如Node.js）。几乎所有的网站都会用到JavaScript来提升用户体验。

公司是否对这些语言的编码规范做了规定

大多数公司会对常用的编程语言制定编码规范，原因如下：

提升代码可读性：统一的规范使得不同开发人员编写的代码风格一致，便于团队成员之间相互理解和阅读代码，降低沟通成本。例如，规定了统一的命名规范后，看到变量名就能大概了解其用途。
提高代码可维护性：规范的代码结构和注释要求，方便后续对代码进行修改、扩展和排查问题。比如按照规范编写的函数，其输入输出明确，功能清晰，在维护时能快速定位和修改。
保证代码质量：编码规范中可能包含对代码安全性、性能优化等方面的指导，有助于开发人员编写出高质量的代码。例如，规定了内存管理的规范，可避免内存泄漏等问题。

具体的规定内容可能包括上述提到的命名规范、代码格式规范、注释规范，以及函数设计原则（如函数长度限制、参数传递方式等）、错误处理规范（如何抛出和捕获异常）等方面。

编程活动在什么时候开始启动

编程活动通常在以下阶段之后启动：

项目需求明确：通过与客户、业务分析师等相关方充分沟通，确定了项目要实现的具体功能、性能指标、用户体验要求等各项需求后，才能知道要编写什么样的代码来满足这些需求。
项目计划制定：包括确定项目的开发周期、里程碑节点、资源分配（如开发人员数量、硬件资源等）等，明确了编程活动在整个项目进度中的时间安排和资源保障情况。
软件设计完成：完成软件架构设计、数据库设计、模块划分及接口设计等工作，为编程提供了清晰的框架和具体的实现思路，开发人员依据这些设计来开展编码工作。

编写的程序是如何知道满足设计的

可以通过以下几种方式来判断编写的程序是否满足设计要求：

代码审查：团队内部成员之间相互审查代码，依据设计文档检查代码的结构、逻辑、功能实现等是否与设计一致。例如，设计文档规定了某个模块的接口参数和返回值类型，在代码审查时就可检查代码中该模块的实现是否符合这些要求。
单元测试：针对代码中的各个单元（如函数、类等）编写测试用例，验证其功能是否符合预期。通过模拟各种输入情况，检查输出结果是否与设计要求的功能相符。比如设计要求一个函数对输入的数字进行排序，那么单元测试就可以输入不同的数字序列，检查函数输出的排序结果是否正确。
集成测试：将各个模块集成在一起进行测试，检查模块之间的接口是否兼容，整个系统的功能是否完整且符合设计。例如，在开发一个电商系统时，将商品管理模块、订单处理模块、用户管理模块等集成后，测试购物流程等功能是否能按照设计正常运行。
与设计文档对比：在编码过程中以及完成编码后，开发人员要不断将代码的实现与设计文档进行细致比对，从整体架构到具体功能细节，确保代码准确无误地实现了设计要求。

如何确保代码的质量

确保代码质量可以从以下几个方面入手：

遵循编码规范：严格按照公司制定的编码规范以及编程语言的最佳实践规范来编写代码，保证代码的可读性、可维护性等。
进行代码审查：团队成员之间相互审查代码，发现并纠正代码中的逻辑错误、不符合规范的地方、潜在的性能问题等。可以采用正式的代码审查会议形式，也可以通过代码审查工具在线进行。
编写单元测试：为代码中的各个单元编写测试用例，确保每个单元的功能都能正确实现，并且在后续代码修改时，通过重新运行单元测试可以快速检测是否引入了新的问题。
性能优化：在编码过程中考虑代码的性能，如选择合适的数据结构和算法，避免不必要的循环嵌套、重复计算等，提高代码的运行效率。
错误处理：完善的错误处理机制可以增强代码的健壮性。合理地抛出和捕获异常，对可能出现的错误情况进行处理，避免程序因错误而崩溃。

编码验证方式（单元测试、代码走查等）

单元测试：
- 定义：是对软件中的最小可测试单元进行检查和验证的过程。通常针对函数、类等单元编写测试用例。
- 作用：可以尽早发现代码中的错误，保证每个单元的功能正确性，便于后续的代码维护和重构。例如，在开发一个计算器程序时，对加法函数、减法函数等分别编写单元测试用例，输入不同的数值，检查输出结果是否正确。
- 实施步骤：首先确定要测试的单元，然后根据单元的功能需求编写测试用例，包括输入值的设定和预期输出值的确定，最后使用单元测试框架（如Java中的JUnit、Python中的unittest等）来运行测试用例并查看结果。
代码走查：
- 定义：是一种人工的、非正式的代码审查方式，通常由开发人员本人或其他团队成员逐行阅读代码，检查代码的逻辑、语法、是否符合规范等方面的问题。
- 作用：可以发现代码中一些潜在的错误、不符合规范的地方以及可以优化的点。比如在代码走查过程中，可能会发现某个变量的命名不太合理，或者一段代码可以用更简洁的方式来表达。
- 实施步骤：一般由走查人员拿到代码后，从代码的开头逐行进行阅读，边读边思考代码的逻辑和功能，同时对照编码规范检查是否符合要求，发现问题及时记录并反馈给代码作者。