《Good Habits for Great Coding》读书笔记二

• Overview

  Page 79 - 93

• Self Documentitng

  理解Hungarian notation

  Certainly functions should be separated by at least a blank line. Placing a line of dashes or stars between functions is help for reading on paper.

  begin/end, start/stop are better than start end

  We should avoid similar names like str1 and str2, because it is too easy to type one for the other, and the difference between the names is not meaningful.

  Successive commands can be written on the same line provided that, logically, they belong together. The question, as always, is readability.

• Use external documentation,

  in a neat box, place some of the following information:

  1. a title for your program
  2. a program description and maybe some program requirements
  3. your name
  4. the data the document is turned in
  5. the course name, class period/section
  6. the programming language
  7. imported packages, modules, and libraries
  8. key algorithms used
  9. strategy or design implemented in the program
  10. external files

• Step-Wise Refinement

  理解incremental development on Programming

  One way to self-document your code is to use top-down design, a form of structured programming also called step-wise refinement, the goal of which is to choose function names so descriptive that a reader can easily understand the design of a program without reading much computer code or comments.