Skip to content

Instantly share code, notes, and snippets.

@holys
Created May 19, 2013 01:25
Show Gist options
  • Save holys/5606304 to your computer and use it in GitHub Desktop.
Save holys/5606304 to your computer and use it in GitHub Desktop.

长度

每行不超过79个字符。

缩进

保持相同缩进方式,TAB或者空格。 采用4个空格。

缩进的基本情形:

  • 函数体
  • if语句体
  • while语句体
  • for语句体

case语句的选择部分不能缩进。

注释

脚本注释

每个脚本应该包含脚本注释

  • 脚本名称
  • 版本
  • 功能描述
  • 作者
  • 生成日期
  • 其他内容,如版权等

行末注释

起始位置对齐。

区块注释

多行复杂代码应提供必要的注释,说明代码模块逻辑功能

函数注释

说明函数功能、参数及返回值。修改旧代码时就说明函数添加的时间

注释要求

简洁,准确

变量

变量应使用有意义、自说明的名字。

基本规则

  • 英文,数字和下划线构成
  • 全局变量使用UPPER_CASE
  • 局部变量使用lower_case,并用local关键字声明,在声明时初始化

参考

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment