1,072
edits
Octave style guide: Difference between revisions
m
→Indentation
m (→Function names) |
m (→Indentation) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 19: | Line 19: | ||
Use only spaces, and indent 2 spaces at a time. | Use only spaces, and indent 2 spaces at a time. | ||
Absolutely '''do not use tabs''' in your code. You should probably set your editor to emit spaces when you hit the tab key. | |||
You should probably set your editor to emit spaces when you hit the tab key. | |||
=== Whitespace === | === Whitespace === | ||
| Line 115: | Line 114: | ||
== Naming == | == Naming == | ||
Use lowercase names if possible. Uppercase is acceptable for variable names consisting of 1-2 letters. Do not use mixed case names. | Use lowercase names if possible. Uppercase is acceptable for variable names consisting of 1-2 letters. Do not use mixed case (a.k.a. CamelCase) names. | ||
Function names must be lowercase. Function names are global, so choose them wisely. | Function names must be lowercase. Function names are global, so choose them wisely. | ||
| Line 126: | Line 125: | ||
For functions that are not present in Matlab, favor the use of underscores. | For functions that are not present in Matlab, favor the use of underscores. | ||
For example, {{codeline|base64_decode}}, {{codeline|common_size}}, or | For example, {{codeline|base64_decode}}, {{codeline|common_size}}, or {{codeline|compare_versions}}. | ||
{{codeline|compare_versions}}. There are exceptions to this: | |||
There are exceptions to this: | |||
; Matching C functions | ; Matching C functions | ||
| Line 138: | Line 138: | ||
Avoid reusing the names of other functions as local variable names. For | Avoid reusing the names of other functions as local variable names. For | ||
example, avoid naming local variables {{codeline|abs}}, | example, avoid naming local variables {{codeline|abs}}, | ||
{{codeline|log}}, or {{codeline|pow}}. These names might be used later to try to call the function | {{codeline|log}}, or {{codeline|pow}}. These names might be used later to try to call the function of that name, but instead will refer to a local variable, leading to very confusing errors. | ||
An exception is the use of {{codeline|i}} and {{codeline|j}} as loop indices. | An exception is the use of {{codeline|i}} and {{codeline|j}} as loop indices. | ||