software-engineering

Introduction

software-engineering

GitHub

Introduction
Software-engineering
Software-engineering
- Introduction
Software-quality
Software-quality
- Introduction
- Reusability
  Reusability
  - Introduction
- Readability
  Readability
  - Introduction Introduction
    Table of contents
    
    wikipedia Readability of source code
    
    wikipedia Self-documenting code
    
    Code style
    
    TODO: Name convention
Software-requirements
Software-requirements
- Introduction
Software-design
Software-design
- Introduction
- Principle
  Principle
  - Introduction
  - Abstraction
    Abstraction
    
    Abstraction-in-software-design
  - Control-theory
    Control-theory
    
    Introduction
    
    Inversion-of-control
    Inversion-of-control
    
    Introduction
    
    wikipedia-Inversion-of-control
    
    tutorialsteacher-Inversion-of-Control
    
    TODO-Control-dependency
    TODO-Control-dependency
    
    Introduction
  - Information-hiding
    Information-hiding
    
    Introduction
    
    Transparency
    Transparency
    
    Introduction
- Commonality-and-variability-analysis
  Commonality-and-variability-analysis
  - Introduction
- Decompose-and-assemble
  Decompose-and-assemble
  - Introduction
- Design-pattern
  Design-pattern
  - Introduction
  - Architecture-pattern
    Architecture-pattern
    
    Introduction
    
    Plugin-architecture
    Plugin-architecture
    
    Introduction
    
    Component-based-software-engineering
    
    Monolithic-and-micro
    Monolithic-and-micro
    
    Introduction
    
    Middleware
    Middleware
    
    Introduction
    
    Message-oriented-middleware
    Message-oriented-middleware
    
    Introduction
    
    Service-oriented-architecture
    Service-oriented-architecture
    
    Introduction
    
    Microservice
    Microservice
    
    Introduction
    
    Task-model
    Task-model
    
    Introduction
    
    Schedule
    Schedule
    
    Introduction
    
    Priority-inversion
    Priority-inversion
    
    Introduction
    
    Multilayered-architecture
    Multilayered-architecture
    
    Introduction
    
    Abstraction-and-architecture-and-layer
    
    Book-code-reading
    Book-code-reading
    
    Introduction
  - Pool
    Pool
    
    Introduction
    
    Prefork-process-pool
    Prefork-process-pool
    
    Introduction
    
    Memory-pool
    Memory-pool
    
    Introduction
    
    C++Memory-Pool-CTable
    C++Memory-Pool-CTable
    
    Introduction
    
    Connection-pool
    Connection-pool
    
    Introduction
- Experience
- UML
  UML
  - Introduction
Software-development
Software-development
- Introduction
- Development-process
  Development-process
  - Introduction
  - TDD&BDD
    TDD&BDD
    
    Introduction
    
    TDD
    TDD
    
    Introduction
    
    BDD
    BDD
    
    Introduction
    
    software-Cucumber
    software-Cucumber
    
    Introduction
    
    Gherkin
    Gherkin
    
    Introduction
- Configuration-management
  Configuration-management
  - Introduction
- Software-build
  Software-build
  - Introduction
- QA
  QA
  - Introduction
- Testing
  Testing
  - Introduction
  - Test-automation
    Test-automation
    
    Introduction
    
    Automated-test-framework
    Automated-test-framework
    
    Introduction
    
    Test-Anything-Protocol
    Test-Anything-Protocol
    
    Introduction
  - Unit-testing
    Unit-testing
    
    Introduction
    
    xUnit
    xUnit
    
    Introduction
    
    Test-oracle
    Test-oracle
    
    Introduction
  - Smoke-testing
    Smoke-testing
    
    Introduction
  - Fuzz-testing
    Fuzz-testing
    
    Introduction
    
    google-oss-fuzz
    google-oss-fuzz
    
    Introduction
  - Code-coverage
    Code-coverage
    
    Introduction
  - Bugs
    Bugs
    
    Introduction
    
    Heisenbug
    Heisenbug
    
    Introduction
- 质量提升
  质量提升
  - Introduction
Software-distribution
Software-distribution
- Introduction
- Software-release-life-cycle
TODO-Software-analysis
TODO-Software-analysis
- Introduction
DevOps
DevOps
- Introduction
- 12factor
  12factor
  - Introduction

Readability of source code

wikipedia Readability of source code

NOTE:

如何来保证代码的可读性？

wikipedia Self-documenting code

关于self-document code，在阅读namedtuple() 的文档的时候，看到了它的身影：

Named tuples assign meaning to each position in a tuple and allow for more readable, self-documenting code. They can be used wherever regular tuples are used, and they add the ability to access fields by name instead of position index.

Code style

正如python有：

PEP 7 -- Style Guide for C Code

Readability of source code

wikipedia Readability of source code

wikipedia Self-documenting code

Code style

TODO: Name convention