24 lines
922 B
Markdown
24 lines
922 B
Markdown
---
|
|
title: 应用开发通用规范
|
|
tags:
|
|
- standards
|
|
- best-practice
|
|
- engineering
|
|
author:
|
|
name: Zihlu Wang
|
|
email: real@zihluwang.me
|
|
---
|
|
|
|
## 引言
|
|
|
|
本文件旨在概述应用程序开发的编码标准和最佳实践。遵守这些指导方针可确保所有项目的代码质量、可维护性和一致性。
|
|
|
|
## 通用原则
|
|
|
|
- **清晰性与可读性**: 代码必须易于阅读和理解。优先选择清晰、自文档化的代码，而非巧妙、简洁但晦涩的解决方案。
|
|
- **一致性**: 在整个项目中保持一致的编码风格、命名约定和架构模式。
|
|
- **模块化**: 设计组件时应实现松耦合和高内聚，以促进重用性和更简单的测试。
|
|
- **可测试性**: 编写本质上可测试的代码。
|
|
- **安全先行设计**: 在开发的每个阶段都将安全考虑融入其中。
|
|
- **性能意识**: 对关键代码段和 API 端点考虑其性能影响。
|