编码规范

日期 作者 备注
2013-11-30 曾嵘 初始化
2013-12-31 曾嵘 加入类名和创建信息定义
2014-10-30 曾嵘 为黄鹤楼进行修改

Lua 编码规范

1. 名称

1.1 类名称

  1. 类名首字母大写,然后使用驼峰式命名法;类名的文件名与类名相同;
  2. 配置文件运行文件(非类) 采用首字母小写,然后使用驼峰式命名法;配置文件名与类名相同;
  3. 静态方法(类方法)使用 . 定义,实例方法使用 : 定义;
  4. 所有方法以小写字母开头,使用驼峰式命名法;
  5. 常量使用大写字母,单词之间使用 _ 分割;
  6. 私有变量/常量/方法使用 _ 开头。

1.2 文件夹和资源名称

  • 包名(文件夹)全部使用小写字母,禁止使用下划线 _ ,禁止使用驼峰命名,尽量保持简短,可使用简称;
  • 各种资源(文件夹)和资源文件名本身全部使用小写字母,使用下划线 _ 分割,禁止使用驼峰命名法。

2. 创建信息

每个文件的开头采用下面的格式标明创建信息。在对文件进行修改之后,请更新最后修改日期。

英文模版::

--- Manager Heros
-- @author zrong
-- Creation 2013-11-26
-- Last modification 2013-12-14

中文模版::

--- 管理英雄对象
-- @author zrong
-- 创建日期 2013-11-26
-- 最后修改 2013-12-14

3. 字符串

  • 字符串必须使用 _("你好世界!") 的方式来调用,翻译工具会自动从代码中抽取需要翻译的内容
  • 调试信息,不要使用 _ 方法调用。

4. 注释

  1. 让变量、方法命名清晰,排版统一,减少注释的使用;

  2. 注意注释的目的是 解释思路 ,而不是 解释代码

  3. 复杂的逻辑和算法必须加详细注释;

  4. 临时取消某个功能,但可能以后重新启用的,在注释中要标明日期和修改者名字以及取消功能的原因,例如::

    if display.width > 1900 or display.height > 1000 then
        --- 2013-11-30 zrong
        -- 在 quick 中不能设置缩放系数,因为 setFrameZoomFactor 只能在 win32 系统中使用。
        --cc.Director:getInstance():getOpenGLView():setFrameZoomFactor(0.8)
    end
    
  5. 过时的注释和代码应该立即删除,以免造成其他人的误解。

5. 代码

  1. 缩进使用空格,4字符宽度;
  2. 每行代码不要超过80字符,超过80字符必须换行;
  3. 超过2个的链式调用必须换行,换行时冒号前置;
  4. 换行时注意保持正确的缩进;
  5. 每个类方法定义之间保持一个空行。

6. 杂项

  1. 每个方法之间,必须间隔一个空行;
  2. 所有文件使用UTF-8编码;
  3. 所有文件使用 \n 作为换行符。