diff options
author | Anton Samokhvalov <pg83@yandex.ru> | 2022-02-10 16:45:17 +0300 |
---|---|---|
committer | Daniil Cherednik <dcherednik@yandex-team.ru> | 2022-02-10 16:45:17 +0300 |
commit | d3a398281c6fd1d3672036cb2d63f842d2cb28c5 (patch) | |
tree | dd4bd3ca0f36b817e96812825ffaf10d645803f2 /util/README.md | |
parent | 72cb13b4aff9bc9cf22e49251bc8fd143f82538f (diff) | |
download | ydb-d3a398281c6fd1d3672036cb2d63f842d2cb28c5.tar.gz |
Restoring authorship annotation for Anton Samokhvalov <pg83@yandex.ru>. Commit 2 of 2.
Diffstat (limited to 'util/README.md')
-rw-r--r-- | util/README.md | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/util/README.md b/util/README.md index 5b44ea3dd8..496efa633c 100644 --- a/util/README.md +++ b/util/README.md @@ -1,5 +1,5 @@ # Coding style - + Style guide for the util folder is a stricter version of [general style guide](https://docs.yandex-team.ru/arcadia-cpp/cpp_style_guide) (mostly in terms of ambiguity resolution). @@ -9,31 +9,31 @@ Style guide for the util folder is a stricter version of * always use `using` not `typedef` * even a single line block must be in braces {}: ``` - if (A) { - B(); - } + if (A) { + B(); + } ``` * _ at the end of private data member of a class - `First_`, `Second_` * every .h file must be accompanied with corresponding .cpp to avoid a leakage and check that it is self contained * prohibited to use `printf`-like functions - - + + Things declared in the general style guide, which sometimes are missed: - + * `template <`, not `template<` * `noexcept`, not `throw ()` nor `throw()`, not required for destructors * indents inside `namespace` same as inside `class` - - + + Requirements for a new code (and for corrections in an old code which involves change of behaviour) in util: - + * presence of UNIT-tests * presence of comments in Doxygen style * accessors without Get prefix (`Length()`, but not `GetLength()`) - + This guide is not a mandatory as there is the general style guide. Nevertheless if it is not followed, then a next `ya style .` run in the util folder will undeservedly update authors of some lines of code. - + Thus before a commit it is recommended to run `ya style .` in the util folder. |