Based on the book - Code Complete

What is high Quality Code

• external v.s. internal
• code quality - self-documenting, construction, testable

Variables

• 宣告變數與使用變數的地方要接近。
• variable live time should be short
• group related statment
• one variable only for one purpose, one meaning
• choose good name, should have a meaning, not too long and not too short
• name for status should have a meaning
• Don't use:
  • keyword
  • similar meanings
  • similar look
  • similar sound
  • misspelled
  • numbers
  • case difference
  • unit natural languages - color, coluor
  • undefined words
  • hard-to-read characters
• Avoid magic numbers
• boolean variable, separate long condition
• use structure to group variables

Statments

• grouping related statments
• condition block should not empty
• don't use goto in loop
• don't: for loop index is changed by inside condition
• use meaning index
• don't use recursion, hard to read and low effiency
• use boolean(true/false) instead of 1/0

• Construction
  • coding and debugging
  • detailed design
  • unit testing
  • construction planning
  • ...
• abstraction
• top-down v.s. bottom-up
• managing complexity - accidental v.s. essenttial difficulties
• high secrets, information hidding - hidding sources and complexity, define public interface, encapsulation
• level of design
  • software system
  • subsystem/packages
  • class in packages
  • data and routines in classes
  • internal routines
• class
  • avoid creating god classes
  • eliminate irrelevated classes
  • don't use verb to name a class
• abstract data type

Routines = Functions

• put into routines
• name: describe everything your method dose, avoid numbers
• unify the similar operation name
• 100 < lines < 200
• Don't assign value to parameters
• variables < 7

Pseudocode

• Use natural language
• steps
  • design
  • write pseudocode
  • coding
  • test
  • repeat if needed