编程规范
编程规范、敏捷宣言、代码风格指南、命名规范、Python代码风格指南、GNU风格版本规则以及Git Commit提交规范都是在软件开发中非常重要的概念和实践。下面我会逐一解释这些概念并提供相关的指南或规范。
- 编程规范:
编程规范是为了确保代码质量、提高代码可读性、可维护性和可重用性而制定的一系列规则和标准。
它通常包括缩进和空格的使用、注释的添加、变量和函数的命名规则、错误处理等方面。
遵循编程规范可以使代码更加清晰、易于理解和维护。
- 敏捷宣言:
敏捷宣言(也称为敏捷软件开发宣言)是一套价值观和指导原则,用于指导迭代、增量、以人为中心的软件开发方法。
它强调四个核心价值:个体和互动高于流程和工具、工作的软件高于详尽的文档、客户合作高于合同谈判、响应变化高于遵循计划。
敏捷宣言还提出了12条原则,用于指导具体的敏捷开发实践。
- 代码风格指南:
代码风格指南是一组详细的规则和标准,用于指导编写高质量、易读、可维护的代码。
它通常包括命名规范、缩进和空格的使用、注释的添加、代码组织等方面。
遵循代码风格指南可以提高代码的一致性和可读性。
- 命名规范:
命名规范是编程规范中的一个重要部分,用于指导变量、函数、类、模块等实体的命名。
通常建议使用有意义的、描述性的名称,避免使用缩写或简写,以及遵循特定的命名约定(如驼峰命名法、下划线命名法等)。
命名规范可以提高代码的可读性和可维护性。
- Python代码风格指南(PEP 8):
PEP 8是Python编程语言的官方代码风格指南。
它包括了一系列关于代码布局、命名约定、注释等方面的规则和建议。
遵循PEP 8可以使Python代码更加一致、易于阅读和维护。
- GNU风格版本规则:
GNU风格版本规则是一种用于命名和版本号管理的规范。
它通常包括主版本号、次版本号、修订号和构建号等部分。
使用GNU风格版本规则可以帮助管理软件的版本和发布过程。
- Git Commit提交规范(Conventional Commits):
Conventional Commits是一种用于规范Git提交信息的规范。
它使用一种特定的格式来描述提交的类型、范围、主题、正文和页脚等信息。
使用Conventional Commits可以使提交历史更加清晰、易于追踪和理解。
以上这些规范和实践在软件开发中扮演着重要的角色,它们有助于提高代码质量、增强代码的可读性和可维护性,并促进团队协作和项目管理。
Flag
- https://github.com/topics/styleguide
- 十二要素 https://github.com/heroku/12factor
- 敏捷宣言 https://agilemanifesto.org
- 贡献者契约 https://github.com/EthicalSource
- License https://en.wikipedia.org/wiki/Software_license
- https://github.com/fossas
- https://spdx.org/licenses
- https://opensource.org/licenses
- 开源指南 https://github.com/github/opensource.guide
- https://creativecommons.org
- https://www.apiref.com
- HTTP 的业务错误码
- https://open.weibo.com/wiki/Error_code
- 适合测试人员看的经典书籍有哪些?
- 《软件测试的艺术》读书笔记
- 软件测试之代码审查和代码走查
- 安全评估 https://github.com/chaitin/xray
- https://github.com/whwlsfb/BurpCrypto
- UUID https://datatracker.ietf.org/doc/html/draft-peabody-dispatch-new-uuid-format
- https://github.com/ai/nanoid
- https://github.com/sony/sonyflake
- https://github.com/segmentio/ksuid
- https://github.com/rs/xid