项目管理 - Coding Standard

阅读目录(Content)

• Code Structure 代码结构
• Design Principles 设计原则
• Structural Complexity 结构复杂度
• Error Handling 错误处理
• Logging 日志
• Unit Testing 测试用例
• Information Security  信息安全

回到顶部(go to top)

Code Structure 代码结构

命名保持规范，驼峰命名。

Boolean方法，起名要以"is" / "has"开头。

方法名称要是动词。

 

......

回到顶部(go to top)

Design Principles 设计原则

Apply the Single-Responsibility principle to increase cohesion

Apply the Open-Closed principle for extensible design

 

......

 

回到顶部(go to top)

Structural Complexity 结构复杂度

Cyclomatic Complexity should not exceed 10

• Methods should not be too complex
• Classes should not have too many methods

Depth of Inheritance Tree should not exceed 5

Lines of code per function should not exceed 100

Parameters per function should not exceed 7

 

 

回到顶部(go to top)

Error Handling 错误处理

Throwable.printStackTrace(...) should not be called

Exceptions should not be thrown in finally blocks

Don't swallow exceptions without commenting why

....

 

回到顶部(go to top)

Logging 日志

Do not log Sensitive / Confidential data (such as passwords)

Log all authentication success and failures

 

 

回到顶部(go to top)

Unit Testing 测试用例

Write unit tests for all new code/projects, and for all bug fixes (including legacy code)

Each function should have unit tests that cover normal conditions, edge conditions and error handling

Use Mock objects in Unit Tests

 

回到顶部(go to top)

Information Security  信息安全

Use strong authentification process

All forms of user input should be validated and sanitized