admin/mruby-mruby
1
0
Fork 0
mirror of https://github.com/mruby/mruby synced 2026-06-08 16:11:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Format the text better and add some more text.

Browse Source
This commit is contained in:
Daniel Bovensiepen
2012-05-13 20:04:04 +08:00
parent c49990610a
commit 5d93850df9
1 changed files with 17 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/coding_conventions.md
+17 -6
View File
@@ -1,15 +1,24 @@
# Coding conventions
How to style your C and Ruby code which you want submit to mruby.
How to style your C and Ruby code which you want to submit.
## 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:
### Comply with C99 (ISO/IEC 9899:1999)
mruby should be highly portable to other systems and compilers. For that it is recommended to keep your code as close as possible to the C99 standard (http://www.open-std.org/jtc1/sc22/WG14/www/docs/n1256.pdf).
### Reduce library dependencies to a minimum
The dependencies to libraries should be put to an absolute minimum. This increases the portability but makes it also easier to cut away parts of mruby on-demand.
### Don't use C++ style comments
/* This is the prefered comment style */
### Insert a break after the method return value:
int
main(void)
@@ -21,4 +30,6 @@ The core part (parser, bytecode-interpreter, core-lib, etc.) of mruby is written
Parts of the standard library of mruby is written in the Ruby programming language itself. Please note the following hints for your Ruby code:
+
### Comply with the Ruby standard (ISO/IEC 30170:2012)
mruby is currently targeting to execute Ruby code which complies to ISO/IEC 30170:2012 (http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=59579).