diff options
Diffstat (limited to 'doc/coding_conventions.md')
| -rw-r--r-- | doc/coding_conventions.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/coding_conventions.md b/doc/coding_conventions.md new file mode 100644 index 000000000..646a052eb --- /dev/null +++ b/doc/coding_conventions.md @@ -0,0 +1,24 @@ +# Coding conventions + +How to style your C and Ruby code which you want submit to mruby. + +## C code + +The core part (parser, bytecode-interpreter, core-lib, etc.) of mruby is written in the C programming language. Please note the following hints for your C code: + ++ comply with C99 [ISO/IEC 9899:1999] ++ don't use C++ style comments, only use /* ... */ ++ reduce library dependencies to a minimum ++ insert a break after the method return value: + + int + main(void) + { + ... + } + +## Ruby code + +Parts of the standard library of mruby is written in the Ruby programming language itself. Please note the following hints for your Ruby code: + ++ |
