diff options
author | practicalswift <practicalswift@users.noreply.github.com> | 2017-05-31 22:21:25 +0200 |
---|---|---|
committer | practicalswift <practicalswift@users.noreply.github.com> | 2017-05-31 22:21:25 +0200 |
commit | 5a9b508279b3a221d36149aa2e811a9702b28e60 (patch) | |
tree | edffb2b9abcbd81f1457b793077a75fec6e389e8 /doc | |
parent | 4c924011f535c46b3bc02bef8b7e2a8ad559d78d (diff) |
[trivial] Add end of namespace comments
Diffstat (limited to 'doc')
-rw-r--r-- | doc/developer-notes.md | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 797507cd3e..7d3427a3b3 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -45,7 +45,7 @@ class Class return true; } } -} +} // namespace foo ``` Doxygen comments @@ -408,6 +408,21 @@ Source code organization - *Rationale*: Avoids symbol conflicts +- Terminate namespaces with a comment (`// namespace mynamespace`). The comment + should be placed on the same line as the brace closing the namespace, e.g. + +```c++ +namespace mynamespace { + ... +} // namespace mynamespace + +namespace { + ... +} // namespace +``` + + - *Rationale*: Avoids confusion about the namespace context + GUI ----- |