RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-05-31 09:58:11 +00:00
Code Issues Activity Actions

Documentation: Swap 'Right' and 'Wrong' code practice

Browse source
This commit is contained in:
flyingwombat921 2022-01-16 22:52:43 +01:00 • committed by Brian Gianforcaro
parent 6e00dd64a1
commit ed271aa7c5
1 changed files with 16 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

32
Documentation/CodingStyle.md
View file

@ -514,22 +514,6 @@ 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. Explain *why* the code does something. The code itself should already say what is happening.
###### Wrong:
```cpp
i++; // Increment i.
```
```cpp
// If the user clicks, toggle the timer state.
catdog_widget.on_click = [&] {
if (advice_timer->is_active())
advice_timer->stop();
else
advice_timer->start();
};
```
###### Right: ###### Right:
```cpp ```cpp
@ -552,6 +536,22 @@ catdog_widget.on_click = [&] {
page_index++; page_index++;
``` ```
###### Wrong:
```cpp
i++; // Increment i.
```
```cpp
// If the user clicks, toggle the timer state.
catdog_widget.on_click = [&] {
if (advice_timer->is_active())
advice_timer->stop();
else
advice_timer->start();
};
```
### Overriding Virtual Methods ### 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. 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.