From 9891d2d3fac4f06f12da7d1a52c925993c0f4e48 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=92=D0=B0=D1=81=D0=B8=D0=BD=20=D0=90=D0=BD=D1=82=D0=BE?= =?UTF-8?q?=D0=BD=20=D0=9E=D0=BB=D0=B5=D0=B3=D0=BE=D0=B2=D0=B8=D1=87?= Date: Wed, 13 Feb 2019 13:11:07 +0000 Subject: [PATCH] Update Codestyle --- Codestyle.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Codestyle.md b/Codestyle.md index dc8ca15..6cb79f3 100644 --- a/Codestyle.md +++ b/Codestyle.md @@ -51,10 +51,10 @@ Комментарии кода используются для описания отдельных строк/блоков кода или целого алгоритма. Комментарии для документирования используются, чтобы описать спецификацию кода, не зависящую от его реализации. Комментарий можно считать полезным, если: -— достаточно прочитать 6 строк комментария вместо 80 строк кода метода с бизнес-логикой; -— в комментарии дается ссылка на реализуемый малоизвестный алгоритм или структуру данных (например — «для поиска подстроки используется алгоритм Ахо — Корасик», ссылка на википедию или спец. сайт); -— комментарий поясняет, почему автор использует не тот подход, который читающий код скорее всего ожидает тут увидеть (например, написанный руками SQL запрос вместо работы через ORM фреймворк, или почему для поиска в XML используется regexp, а не XPath); -— в комментарии дан короткий ясный пример использования. +1. достаточно прочитать 6 строк комментария вместо 80 строк кода метода с бизнес-логикой; +2. в комментарии дается ссылка на реализуемый малоизвестный алгоритм или структуру данных (например — «для поиска подстроки используется алгоритм Ахо — Корасик», ссылка на википедию или спец. сайт); +3. комментарий поясняет, почему автор использует не тот подход, который читающий код скорее всего ожидает тут увидеть (например, написанный руками SQL запрос вместо работы через ORM фреймворк, или почему для поиска в XML используется regexp, а не XPath); +4. в комментарии дан короткий ясный пример использования. Не стоит делать огромных комментариев, отделенных от основного кода строками из "*" или других символов. Комментарии не должны содержать специальных символов, таких как символ конца страницы или backspace. \ No newline at end of file