编码方法和实践因公司和团队而异。在 Evrone,我们创建了自己的一套指南来标准化编写 Python 代码的公司规则。这里我们详细描述了它们的工作原理。
我们的指南主要有四个部分。关于代码部分描述了编写可读且可维护的代码可遵循的某些原则。条件是操作的原子性、逻辑块、方法的大小、函数和模块、文档字符串、__init__.py 文件和导入。
有一个与拉取请求相关的部分。令人惊讶的是, 海外亚洲数据 并非所有开发人员都知道如何创建此类请求或如何审查它们。我们决定将这些决定正式化,这样就不必向每个新开发人员解释。
“关于工具”部分(关于测试、包管理器、代码格式等)有助于使每个开发人员的代码与整体公司风格保持一致。为了避免争论个人偏好,我们使用特殊工具根据某些规则重写整个代码。
有一个单独的部分专门用于 OpenAPI 文档。大量客户端(Swagger、Postman、Insomnia Designer 等)支持此格式。此外,手写文档往往很快就会过时,而直接从代码生成的文档则无需不断考虑更新它。
他们如何在 Evrone 编写 Python 代码?
-
- Posts: 55
- Joined: Mon Dec 23, 2024 5:49 am