Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in or
create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision |
Your text |
Line 217: |
Line 217: |
| Use a single {{codeline|#}} for inline comments. Use double {{codeline|##}} | | Use a single {{codeline|#}} for inline comments. Use double {{codeline|##}} |
| for block comments. | | for block comments. |
|
| |
| Comments that start with a single sharp-sign, {{codeline|#}}, are used to explain
| |
| the code on the same line as the comment itself. These comments should
| |
| all be aligned to the same column to the right of the source code. In
| |
| the Emacs mode for Octave, the {{codeline|M-;}} (@code{indent-for-comment})
| |
| command automatically inserts such a {{codeline|#}} in the right place, or
| |
| aligns such a comment if it is already present. Example:
| |
|
| |
| <pre>
| |
| C = 2 * pi * r; # formula for circumference of a circle
| |
| </pre>
| |
|
| |
| Comments that start with a double sharp-sign, {{codeline|##}}, are stand-alone
| |
| comments that occupy an entire line. These comments should be aligned to
| |
| the same level of indentation as the code. Such comments usually
| |
| describe the purpose of the following lines or the state of the program
| |
| at that point. Example:
| |
|
| |
| <pre>
| |
| ## Calculate area and volume of a sphere
| |
| A = 4 * pi * r^2;
| |
| V = 4/3 * pi * r^3;
| |
| </pre>
| |
|
| |
|
| === Commenting out code === | | === Commenting out code === |