Current File : //usr/share/texlive/texmf-dist/tex/generic/pgf/graphdrawing/lua/LUA_CODING_STYLE

Lua coding style for the graphdrawing library
=============================================

General naming rules and indentation:

  * 2 spaces indentation
  * variable_names_with_underscores
  * namespaced.low_level_functions_with_underscores(foo, bar)
  * CamelCaseClassNames
  * CamelCaseClassNames.nameOfStaticFunctionLikeNewOrClone(foo, bar)
  * CamelCaseClass:functionNamesLikeThis(foo, bar)
  * never use global variables
  * Use . for static functions and : for member functions

LuaDoc comments:

  ---
  -- A function to do this and that.
  --
  -- @param first  Description of the first parameter.
  -- @param second Description of the second parameter.
  --
  -- @return This function returns something.
  --
  function myClass:myFunction(first, second) 
    ...
  end