Skip to content

Commit 24bd9da

Browse files
committed
add note to comments page
1 parent 00d4652 commit 24bd9da

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

Diff for: content/code-style/comments.qmd

+2
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ To make this quick and easy, in the MATLAB editor you can use the following key
4242

4343
+ <kbd>Ctrl</kbd>+<kbd>/</kbd> and <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>/</kbd> on Linux
4444

45+
**Note**: This depends on your MATLAB keyboard settings and can be changed to suit your preference.
46+
4547
Comments are one element of good coding practice that I find most developers (that's people who write code, i.e. you!) are familiar with, so this shouldn't come as too much of a shock. However, they aren't a substitute for the generally good coding practices described throughout this guide.
4648

4749
Large sections of comments should be avoided and if you find that your code needs them, it may be an indication that restructuring your code or using documentation (described [later](documentation.qmd)) instead may result in something easier to understand.

0 commit comments

Comments
 (0)