Merge #12982: Fix inconsistent namespace formatting guidelines
cd0e1e91dd
Fix inconsistent namespace formatting guidelines (Russell Yanofsky)
Pull request description:
Suggested formatting for namespaces in the developer guide is currently inconsistent. This commit updates the developer guide and clang-format configuration to consistently put "namespace" and opening/closing braces on the same line. Example:
```c++
namespace boost {
namespace signals2 {
class connection;
} // namespace signals2
} // namespace boost
```
Currently the [Source code organization](https://github.com/bitcoin/bitcoin/blob/master/doc/developer-notes.md#source-code-organization) section has an example like the one above, but the [Coding style](https://github.com/bitcoin/bitcoin/blob/master/doc/developer-notes.md#coding-style) section example and description put a newline between the opening "namespace foo" and brace (but oddly no newline between closing namespace and brace).
Avoiding newlines before namespace opening braces makes nested declarations less verbose and also avoids asymmetry with closing braces. It's also a common style used in our own and other codebases:
* https://google.github.io/styleguide/cppguide.html#Namespaces
* https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style#Classes
* https://llvm.org/docs/CodingStandards.html#namespace-indentation
Tree-SHA512: 507259478e1a7f6f96db386dd04eb25aa04294f533503fdd82368cf809c3ceaa20204b2cb6ae65322eb27446e5934c1aa1ccb6240ead12aa06b314af76f68139
This commit is contained in:
commit
a63b4e3493
2 changed files with 8 additions and 6 deletions
|
@ -50,7 +50,7 @@ Do not submit patches solely to modify the style of existing code.
|
||||||
[src/.clang-format](/src/.clang-format). You can use the provided
|
[src/.clang-format](/src/.clang-format). You can use the provided
|
||||||
[clang-format-diff script](/contrib/devtools/README.md#clang-format-diffpy)
|
[clang-format-diff script](/contrib/devtools/README.md#clang-format-diffpy)
|
||||||
tool to clean up patches automatically before submission.
|
tool to clean up patches automatically before submission.
|
||||||
- Braces on new lines for namespaces, classes, functions, methods.
|
- Braces on new lines for classes, functions, methods.
|
||||||
- Braces on the same line for everything else.
|
- Braces on the same line for everything else.
|
||||||
- 4 space indentation (no tabs) for every block except namespaces.
|
- 4 space indentation (no tabs) for every block except namespaces.
|
||||||
- No indentation for `public`/`protected`/`private` or for `namespace`.
|
- No indentation for `public`/`protected`/`private` or for `namespace`.
|
||||||
|
@ -85,8 +85,7 @@ Block style example:
|
||||||
```c++
|
```c++
|
||||||
int g_count = 0;
|
int g_count = 0;
|
||||||
|
|
||||||
namespace foo
|
namespace foo {
|
||||||
{
|
|
||||||
class Class
|
class Class
|
||||||
{
|
{
|
||||||
std::string m_name;
|
std::string m_name;
|
||||||
|
@ -585,11 +584,11 @@ Source code organization
|
||||||
|
|
||||||
```c++
|
```c++
|
||||||
namespace mynamespace {
|
namespace mynamespace {
|
||||||
...
|
...
|
||||||
} // namespace mynamespace
|
} // namespace mynamespace
|
||||||
|
|
||||||
namespace {
|
namespace {
|
||||||
...
|
...
|
||||||
} // namespace
|
} // namespace
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -12,7 +12,10 @@ AlwaysBreakBeforeMultilineStrings: false
|
||||||
AlwaysBreakTemplateDeclarations: true
|
AlwaysBreakTemplateDeclarations: true
|
||||||
BinPackParameters: false
|
BinPackParameters: false
|
||||||
BreakBeforeBinaryOperators: false
|
BreakBeforeBinaryOperators: false
|
||||||
BreakBeforeBraces: Linux
|
BreakBeforeBraces: Custom
|
||||||
|
BraceWrapping:
|
||||||
|
AfterClass: true
|
||||||
|
AfterFunction: true
|
||||||
BreakBeforeTernaryOperators: false
|
BreakBeforeTernaryOperators: false
|
||||||
BreakConstructorInitializersBeforeComma: false
|
BreakConstructorInitializersBeforeComma: false
|
||||||
ColumnLimit: 0
|
ColumnLimit: 0
|
||||||
|
|
Loading…
Reference in a new issue