diff options
Diffstat (limited to 'Documentation/CodingStyle.md')
| -rw-r--r-- | Documentation/CodingStyle.md | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/Documentation/CodingStyle.md b/Documentation/CodingStyle.md index 2cd7aa1b94..385867c20e 100644 --- a/Documentation/CodingStyle.md +++ b/Documentation/CodingStyle.md @@ -514,14 +514,14 @@ draw_jpg(); // TODO: Make this code handle jpg in addition to the png support. Explain *why* the code does something. The code itself should already say what is happening. -###### Wrong: +###### Right: ```cpp -i++; // Increment i. +i++; // Go to the next page. ``` ```cpp -// If the user clicks, toggle the timer state. +// Let users toggle the advice functionality by clicking on catdog. catdog_widget.on_click = [&] { if (advice_timer->is_active()) advice_timer->stop(); @@ -530,14 +530,20 @@ catdog_widget.on_click = [&] { }; ``` -###### Right: +###### Even better: ```cpp -i++; // Go to the next page. +page_index++; +``` + +###### Wrong: + +```cpp +i++; // Increment i. ``` ```cpp -// Let users toggle the advice functionality by clicking on catdog. +// If the user clicks, toggle the timer state. catdog_widget.on_click = [&] { if (advice_timer->is_active()) advice_timer->stop(); @@ -546,12 +552,6 @@ catdog_widget.on_click = [&] { }; ``` -###### Even better: - -```cpp -page_index++; -``` - ### Overriding Virtual Methods The declaration of a virtual method inside a class must be declared with the `virtual` keyword. All subclasses of that class must either specify the `override` keyword when overriding the virtual method or the `final` keyword when overriding the virtual method and requiring that no further subclasses can override it. |