Constants with end of line comments
ID | LAYOUT-19 |
Title | Document constants with end of line comments. |
Priority | Recommended |
Severity level | 7 |
Description | Document constants with end of line comments. |
Rationale | Although variable names should generally speak for themselves, comments can be useful to provide additional information such as units. |
Avoid:
THRESHOLD = 10;
Instead use:
THRESHOLD = 10; % [dB] Max noise level