siujamo
27 lines
1.0 KiB
Markdown
27 lines
1.0 KiB
Markdown
---
|
|
title: General Application Development Standards
|
|
tags:
|
|
- standards
|
|
- best-practice
|
|
- engineering
|
|
author:
|
|
name: Zihlu Wang
|
|
email: real@zihluwang.me
|
|
---
|
|
|
|
## Introduction
|
|
|
|
This document outlines coding standards and best practices for application development. Adhering to these guidelines
|
|
ensures code quality, maintainability, and consistency across all projects.
|
|
|
|
## General Principles
|
|
|
|
- **Clarity & Readability**: Code must be easy to read and understand. Prefer clear, self-documenting code over clever,
|
|
terse, but obscure solutions.
|
|
- **Consistency**: Maintain a consistent coding style, naming conventions, and architectural patterns across the
|
|
project.
|
|
- **Modularity**: Design components with loose coupling and high cohesion to promote reusability and simpler testing.
|
|
- **Testability**: Write code that is inherently testable.
|
|
- **Security-First Design**: Incorporate security considerations at every stage of development.
|
|
- **Performance Awareness**: Be mindful of performance implications for critical code paths and API endpoints.
|