Difference between revisions of "Style"

From KolibriOS wiki
Jump to navigation Jump to search
Line 1: Line 1:
<b>SVN rules:</b><br><br>
+
== SVN kernel rules ==
 
* No tab characters allowed.
 
* No tab characters allowed.
 
* Code labels must be on a separate line. It is not allowed to have a label and a command on the same line. Combinations of label and data in one line is allowed.
 
* Code labels must be on a separate line. It is not allowed to have a label and a command on the same line. Combinations of label and data in one line is allowed.
Line 7: Line 7:
 
* All code and text files should be in UTF-8 without BOM.
 
* All code and text files should be in UTF-8 without BOM.
  
<br><b>Suggestions:</b><br><br>
+
== Recommendations ==
 
+
The most important thing is to describe you subroutines:
* Don't place a space after a typename (byte/word/dword/..).
+
* purpose
* place 2 spaces before a local label, this way it will 'pop out' between the subprogram name and the code
+
* input data
* Only cast when nescessary.
+
* output data
* When you need to cast, do it on the memory location, not on the operand.
+
* spoiled registers
* Place a space after comma.
+
<syntaxhighlight lang="asm">
 +
; doing job
 +
subroutine:
 +
; in:  eax = some data
 +
;      ebx -> some pointer
 +
; out: eax = result data
 +
; destroys ebx</syntaxhighlight>
  
 
[[Category:Coding]]
 
[[Category:Coding]]

Revision as of 23:09, 10 February 2016

SVN kernel rules

  • No tab characters allowed.
  • Code labels must be on a separate line. It is not allowed to have a label and a command on the same line. Combinations of label and data in one line is allowed.
  • Lines with commands must start with 8 spaces. A mnemonic is short if it's length is less than 8. Arguments for short mnemonics must start in the column 16. Arguments for long mnemonics must be separated from the mnemonic by exactly one space. Arguments must be separated with a comma and exactly one space after a comma. Arguments continued in the next line must start from the same position as in the first line.
  • Prefixes lock/rep[z|e|nz|ne] are considered as a logical part of the command, so they start at position 8, then after exactly one space follows the main mnemonic and arguments.
  • The special property 'svn:eol-style' must be set to 'native'.
  • All code and text files should be in UTF-8 without BOM.

Recommendations

The most important thing is to describe you subroutines:

  • purpose
  • input data
  • output data
  • spoiled registers
; doing job
subroutine:
; in:  eax = some data
;      ebx -> some pointer
; out: eax = result data
; destroys ebx