Become a better CODER

[rain1024]

Mã sạch • Chạy tất cả các kiểm thử; • Không có sự trùng lặp; • Diễn đạt tất cả các ý tưởng thiết kế có trong hệ thống; • Có tối thiểu số lượng các lớp, phương thức, chức năng, và những thứ tương tự.

Scaffolding Package Management

Names	Functions	Comments	Formatting	Object and Data Structure
~	~	~	~	~

Error Handling	Boundaries	Unit Tests	Class	Systems
~	~	~	~	~

Emergence	Concurrency	Successive Refinement	Class	Systems
~	~	~	~	~

Naming

Clean Code, Chapter 2: Meaningful Names

Language	File	Function	Class
Python	file_name	functionName	ClassName

• Use Intention-Revealing Names

# NOT
int d; // elapsed time in days

# HOT
int elapsedTimeInDays;
int daysSinceCreation;
int daysSinceModification;
int fileAgeInDays;

• Avoid Disinformation

# NOT1
accountList // in case accountList is not a real List
# HOT1
accountGroup

# NOT2
// lower-case L or uppercase O as variable names, especially in combination
int a = l;
if ( O == l )
 a = O1;
else
 l = 01;

Design Principles

SOLID

• Single Responsibility Principle (đơn nhiệm)
• Open Close Principle (mở đóng)
• Liskov's Substitution Principle
• Interface Segregation Principle
• Dependency Inversion Principle (đảo ngược sự phụ thuộc)

  The Productivity Practices Stack

• Refactoring
• Automated Tests
• Continuous Integration
• Automated Build and Deploy
• Version Control System

  References

• Server.dzone.com, (2014). Best Best Practices Ever | Server Zone. [online] Available at: http://server.dzone.com/articles/best-best-practices-ever [Accessed 16 Jul. 2014].
• Đới, (2014). Mã sạch. [online] Tạp chí Lập trình. Available at: http://tapchilaptrinh.vn/2014/05/26/ma-sach/ [Accessed 16 Jul. 2014].
• GitHub, (2014). yeoman/yeoman. [online] Available at: https://github.com/yeoman/yeoman/wiki/Generators [Accessed 16 Jul. 2014].

[rain1024]

Functions

• Small
• Do One Thing
• One Level of Abstraction per Function
• Switch Statements
• Use Descriptive Names
• Function Arguments
• Have No Side Effects

[rain1024]

Comments

[rain1024]

Scaffolding

References

• Paulfreeman.me.uk, (2014). How I Came To Love Yeoman By Writing My Own Generators | Paul Freeman / Liverpool Developer. [online] Available at: http://paulfreeman.me.uk/development/process/how-i-came-to-love-yeoman-by-writing-my-own-generators [Accessed 17 Jul. 2014].
• Remy.bach.me.uk, (2013). Updating existing files with Yeoman | Personal Website of Rémy Bach. [online] Available at: http://remy.bach.me.uk/blog/2013/10/updating-existing-files-with-yeoman/ [Accessed 17 Jul. 2014].

[rain1024]

Documentation Tips

• You write documentations for people, not for computers, so make it clear, helpful, short and easy for understand

References

• Underscorejs.org, (2014). Underscore.js. [online] Available at: http://underscorejs.org/ [Accessed 23 Jul. 2014].