Skip to content

Coding Style

happlebao edited this page Mar 22, 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 property instead of set.
  3. Use adjective instead of is. e.g. is_valid() -> valid()
  4. Use verb when there is no return result. e.g. PrintMessages()
  5. Don't use self

命名规则

  1. 不用 get,表示取数据懂函数直接描述动作,例:messageFromFile()。
  2. 不用 set,应用 property 替代。
  3. 除非特殊情况,几乎不使用 is, 例:isValid() -> valid()
  4. 对于完成一定动作的函数,使用对应动词,例:printMessages()
  5. 对于返回指定格式或类型的值的函数,使用对应名词 和/或 形容词的组合,例:FormattedTime()
  6. 不要使用 self。