beenull/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-11-21 23:20:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Documentation: Remove some irrelevant things from the coding style.

Browse source 
This was adapted from the WebKit coding style docs, but some parts of it
don't make sense for Serenity.
This commit is contained in:
Andreas Kling 2019-05-28 11:43:28 +02:00
parent fc3732759d
commit 854598bc46
Notes: sideshowbarker 2024-07-19 13:52:28 +09:00 
Author: https://github.com/awesomekling
Commit: https://github.com/SerenityOS/serenity/commit/854598bc46b
1 changed files with 1 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
Documentation/CodingStyle.md
View file

@ -687,8 +687,6 @@ do_something(something, false);
set_resizable(NotResizable);
```
[](#names-objc-methods) Objective-C method names should follow the Cocoa naming guidelines — they should read like a phrase and each piece of the selector should start with a lowercase letter and use intercaps.
[](#names-enum-members) Enum members should use InterCaps with an initial capital letter.
[](#names-const-to-define) Prefer `const` to `#define`. Prefer inline functions to macros.
@ -831,39 +829,12 @@ void MyClass::get_some_value(OutArgumentType* outArgument) const
### #include Statements
[](#include-config-h) All implementation files must `#include` `config.h` first. Header files should never include `config.h`.
###### Right:
```cpp
// RenderLayer.h
#include "Node.h"
#include "RenderObject.h"
#include "RenderView.h"
```
###### Wrong:
```cpp
// RenderLayer.h
#include "config.h"
#include "RenderObject.h"
#include "RenderView.h"
#include "Node.h"
```
[](#include-primary) All implementation files must `#include` the primary header second, just after `config.h`. So for example, `Node.cpp` should include `Node.h` first, before other files. This guarantees that each header's completeness is tested. This also assures that each header can be compiled without requiring any other header files be included first.
[](#include-others) Other `#include` statements should be in sorted order (case sensitive, as done by the command-line sort tool or the Xcode sort selection command). Don't bother to organize them in a logical order.
[](#include-others) `#include` statements should be in sorted order (case sensitive, as done by the command-line sort tool or an IDE sort selection command). Don't bother to organize them in a logical order.
###### Right:
```cpp
// HTMLDivElement.cpp
#include "config.h"
#include "HTMLDivElement.h"
#include "Attribute.h"
#include "HTMLElement.h"
#include "QualifiedName.h"