Skip to content

Coding Style

happlebao edited this page Mar 2, 2017 · 6 revisions

Must read

中文: 编程的智慧

English:translation1 translation2

Naming style

  1. Use noun instead of get when function return result. e.g. MessageFromFile, FormattedTime
  2. Use verb when there is no return result. e.g. PrintMessages
  3. Don't use self

命名规则

  1. 不要用 get 作为函数名,表示取数据懂函数直接描述动作,例:MessageFromFile
  2. 对于完成一定动作的函数,使用对应动词,例:PrintMessages
  3. 对于返回指定格式或类型的值的函数,使用对应名词 和/或 形容词(的组合),例:FormattedTime
  4. 不要使用 self