Difference between revisions of "Style"

From KolibriOS wiki
Jump to navigation Jump to search
m
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
Here is a quick draft of what may become a good guideline of how to format your code:
+
== 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.
  
−
* Do not place code on a the same line as a label.
+
== Recommendations ==
−
* Use tabs before and after instructions.
+
* Variables must have either a comprehensive name or a commentary.
−
* Place a space after comma.
+
* The same is advisable for labels, as well as arrange them in a separate line without indent.
−
* Don't place a space after a typename (byte/word/dword/..).
+
* When writing a subroutine, it is very important to describe it's purpose, input and output data, spoiled registers:
 +
<syntaxhighlight lang="asm">
 +
; doing job
 +
subroutine:
 +
; in:  eax = some data
 +
;      ebx -> some pointer
 +
; out: eax = result data
 +
; destroys ebx</syntaxhighlight>
 +
 
 +
* Only cast when necessary, FASM keeps track of data types for you, use this functionality to write flexible code.  
 
* When you need to cast, do it on the memory location, not on the operand.
 
* When you need to cast, do it on the memory location, not on the operand.
−
* Only cast when nescessary.
 
−
* place 2 spaces before a local label, this way it will 'pop out' between the subprogram name and the code
 
−
*
 
  
 
[[Category:Coding]]
 
[[Category:Coding]]

Latest revision as of 19:12, 4 March 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

  • Variables must have either a comprehensive name or a commentary.
  • The same is advisable for labels, as well as arrange them in a separate line without indent.
  • When writing a subroutine, it is very important to describe it's purpose, input and output data, spoiled registers:
; doing job
subroutine:
; in:  eax = some data
;      ebx -> some pointer
; out: eax = result data
; destroys ebx
  • Only cast when necessary, FASM keeps track of data types for you, use this functionality to write flexible code.
  • When you need to cast, do it on the memory location, not on the operand.
Retrieved from "http://wiki.kolibrios.org/index.php?title=Style&oldid=5299"