cerc-io/solidity
16
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #3946 from ethereum/chriseth-patch-1

Browse Source 
Clarify namespaces in coding style.
This commit is contained in:
Alex Beregszaszi 2018-04-20 00:07:05 +01:00 committed by GitHub
commit 2028960985
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CODING_STYLE.md
View File

@ -49,21 +49,28 @@ cout << "some very long string that contains completely irrelevant text that tal
## 1. Namespaces ## 1. Namespaces
1. No `using namespace` declarations in header files. 1. No `using namespace` declarations in header files.
2. All symbols should be declared in a namespace except for final applications. 2. Use `using namespace std;` in cpp files, but avoid importing namespaces from boost and others.
3. Use anonymous namespaces for helpers whose scope is a cpp file only. 3. All symbols should be declared in a namespace except for final applications.
4. Preprocessor symbols should be prefixed with the namespace in all-caps and an underscore. 4. Use anonymous namespaces for helpers whose scope is a cpp file only.
5. Preprocessor symbols should be prefixed with the namespace in all-caps and an underscore.
Yes: Only in the header:
```cpp ```cpp
#include <cassert> #include <cassert>
namespace myNamespace
{
std::tuple<float, float> meanAndSigma(std::vector<float> const& _v); std::tuple<float, float> meanAndSigma(std::vector<float> const& _v);
}
``` ```
No: Only in the cpp file:
```cpp ```cpp
#include <cassert> #include <cassert>
using namespace std; using namespace std;
tuple<float, float> meanAndSigma(vector<float> const& _v); tuple<float, float> myNamespace::meanAndSigma(vector<float> const& _v)
{
// ...
}
``` ```
## 2. Preprocessor ## 2. Preprocessor