You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
27 lines
782 B
27 lines
782 B
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
|
|
|