romanov73/ng-tracker
1
0
Fork 0
Code Issues 18 Pull Requests 4 Projects Releases Wiki Activity

Update Codestyle

Васин Антон Олегович 2019-02-13 13:06:11 +00:00
parent 4f6d4af4b0
commit cbaba84578
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Codestyle.md

@ -46,5 +46,15 @@
* Выражения в операторе for должны быть разделены пробелами.
* За приведением типа должен следовать пробел.
4. Комментарии в Java делятся на 2 вида: комментарии реализации и документирующие комментарии. Комментарии реализации те же, что и в C++, обозначаются /* ... */ и //. Документирующие комментарии (известные как "doc comments" или "Javadoc") есть только в Java, и обозначаются /** ... */. Javadoc может быть извлечен из кода в HTML файл, используя инструмент javadoc.
Комментарии кода используются для описания отдельных строк/блоков кода или целого алгоритма. Комментарии для документирования используются, чтобы описать спецификацию кода, не зависящую от его реализации.
Комментарий можно считать полезным, если:
— достаточно прочитать 6 строк комментария вместо 80 строк кода метода с бизнес-логикой;
— в комментарии дается ссылка на реализуемый малоизвестный алгоритм или структуру данных (например — «для поиска подстроки используется алгоритм Ахо — Корасик», ссылка на википедию или спец. сайт);
— комментарий поясняет, почему автор использует не тот подход, который читающий код скорее всего ожидает тут увидеть (например, написанный руками SQL запрос вместо работы через ORM фреймворк, или почему для поиска в XML используется regexp, а не XPath);
— в комментарии дан короткий ясный пример использования.
Не стоит делать огромных комментариев, отделенных от основного кода строками из "*" или других символов.
Комментарии не должны содержать специальных символов, таких как символ конца страницы или backspace.