BabyBus代码规范

前言

代码的规范可以让我们在冗长而无趣的开发中保持愉悦的心情，一般有些年限的程序员都有自己的一套代码规范，而且说起来也是头头是道。一般情况下，刚开始的项目，因为工期不急，逻辑简单单一，我们可以很耐心很规范的去书写我们的代码。整洁,漂亮，结构严谨，边写边点头，满满的成就感！但是一到了工期比较赶或者逻辑比较复杂的时候，我们通常就很少静下来思考如何编排代码，让我们的代码优雅如初。我们选择的是哪里需要写哪里，很多甚至都不管公用的代码，导致到处冗余。冗余重复代码太多就会导致修改一个需求就要动到多个代码文件的下场，不仅修改困难，而且容易遗漏！

视频地址

svn://10.1.1.11/babybus-lua/video/代码规范/代码规范.mov

常见代码问题

• 1.缩进问题
  代码的缩进，是保持代码整齐的一个重要功能，我们要习惯用Tab键来控制我们的代码块

  function M:onTouchBegan()  
    self:doSomeThing(
                  param,
                  function()
                      self:callback()
                  end
                  )
  end

• 2.注释问题
  写得好的代码是不需要注释的，但是我建议逻辑复杂的还是要给一点注释

  --[[ 

  ]]

  和

  //

• 3.命名规范

很多时候我们会看到很多奇葩的命名,例如 addCao , findCha 等中英结合的词语，这种词在给别人阅读代码会造成很大的麻烦。命名最好用英文全称，也不要简写，除非你的简写命名很多人都会知道

驼峰命名法
findCar 由 find 和 car合成，结合一起第二个单词首字母大写
findCarBottom 这个是由3个单词合成，连接的首字母大写，以此类推

尽量不要出现阿拉伯数字和中文
使用阿拉伯数字，意思不明确
使用中文，有可能碰到编码格式中文乱码

如果自己不习惯使用驼峰，习惯使用连接符的话，也可以，但是不要一会驼峰，一会连接符
如 find_car_bottom 一会就findBottom，要有属于自己的风格

避免使用长的名字（小于 15 个字母是个好主意）

• 4.方法书写的格式
  function 和 M的空格保持一个空格就好，不要有3, 4, 5, 6个

function M:onTouchBegan()

  end

• 5.参数的间隔

(params1, params2, params3, params4)

• 6.运算符之间前后要空格

   local a = a 
   a = a + 1

   不要 
   a=a 
   a=a+1
   这样

• 7.方法行数控制
  方法内行数最好不要超过25行，超过了就抽出逻辑成立一个新的方法
• 8.返回值最好放在最后

  function M:method()
    local result = nil
    if condition then 
        result = a
        // 不要这样写
        //return a
    end

    return a
  end

• 9.对象赋值
  如果我们要把node给self._ButtonMe,就只要改一个地方

  function M:loadButton()
    local node = D.img("button.png"):pc():to(self)
    node.a = a
    node.b = b
    node.c = c
    // 修改变量名只要修改一个地方
    self._Button = node
  end

• 10.文件命名
  文件名要跟类名一致，也可以采取驼峰命名类的文件首字母大写, GamePlayerScene.lua对应的类应该如下
  class("GamePlayerScene")，
  classScene("GamePlayer")
• 11.如果类中存在继承,那么习惯调用父类的构造函数和销毁时候调用父类销毁，因为Lua不是真正面向对象
  M.super.ctor(params) super为父类
• 12.抽象类要记得加上Abstract前缀，需要继承的方法，用断言实现.没有实现就报错

function M:implement()
      log.e("implement 尚未实现!!!!")
end

• 13.变量使用，尽量使用非空判断, 经常碰见因为没有非空判断出现错误的，需要养成习惯
• 14.善于抽取公共的组件和工具类的实现，只有一个功能或者组件可能被重复使用2次以上，我们便要把它变成组件，可插拔的组件，那么我们就可以减少重复性代码
• 15.多使用断言J.assert(tag, condition, message)
• 16.学会定期的对自己的代码进行重构，如果你的项目比较赶，你可以一周抽出几小时对你这周的代码进行重构，那么对你的影响必定是深远的。