Project

General

Profile

Bug #5068

[comments] Комментарии к коду

Added by Alexander Kamkin over 5 years ago. Updated almost 5 years ago.

Status:
Closed
Priority:
Urgent
Category:
-
Target version:
Start date:
07/15/2014
Due date:
% Done:

0%

Estimated time:
Detected in build:
svn
Platform:
Published in build:
20141230

Description

Коллеги, я не хочу тратить свое время на ревью вашего кода и коментариев. Бардак в проекте мне не нужен. Вопрос даже не в том, чтобы код был грамотно спроектирован и оптимизирован - вопрос в соблюдении элементарных правил оформления кода.

/**
 * Control flow graph vizualization to Zest
 * 
 * @author <a href="mailto:protsenko@ispras.ru">Alexander Protsenko</a>
 */
  1. Сколько раз нужно сказать, что "vizualization" пишется через "s" ("visualization")?
  2. Что такое "vizualization to"?
  3. В конце коментария должна быть точка (у нас такое соглашение).
  4. Где коментарии к методам?
  5. Почему встречаются символы табуляции?

History

#1

Updated by Alexander Kamkin about 5 years ago

Рекомендации:
  1. Включить отображение пробельных символов
  2. Подключить eclipse-java-google-style.xml
  3. Натравить форматтер на написанный код
  4. Посмотреть, как пишет коментарии Андрей
  5. При написании коментариев соблюдать грамматику английского языка
#2

Updated by Alexander Kamkin about 5 years ago

Еще раз - мы используем соглашения Google по оформлению кода. Нижеприведенный код им не соответствует.

        if(nodeParent != null)
        {
            new GraphConnection(graph, SWT.NONE, node, nodeParent);
        }
#3

Updated by Sergey Smolov almost 5 years ago

  • Priority changed from Normal to High

Мои замечания по отдельным классам ниже:

Во всех классах не забывать про точку в конце комментария в заголовке.

1) src/test/java/ru/ispras/retrascope/engine/cfg/printer/graphml/CfgGraphMlPrinterTestCase.java

Убрать закомментированный код (если он не нужен), разобраться с имеющимися TODO.

2) ru/ispras/retrascope/engine/efsm/printer/graphml/B04EfsmGraphMlPrinterTestCase.java

Удалить пустой метод init.

3) src/test/java/ru/ispras/retrascope/util/VhdlUtilTest.java

Не вылезать за пределы разрешенной длины строки (100 символов).

4) ru/ispras/retrascope/engine/cfg/printer/graphml/CfgGraphMlVisitor.java

Удалить закомментированный код.

5) ru/ispras/retrascope/engine/efsm/printer/graphml/EfsmGraphMlPrinter.java

Удалить неиспользуемый конструктор.

6) ru/ispras/retrascope/engine/efsm/printer/graphml/EfsmGraphMlVisitor.java

Разобраться с имеющимися TODO.

И маленькое пожелание: предлагаю в пустых @Override-методах везде писать один и тот же комментарий, а то сейчас бывает и Empty, и Nothing...

Задача выполняется легко, а "зима близко", поэтому приоритет повышаю.

#4

Updated by Alexander Kamkin almost 5 years ago

  • Priority changed from High to Urgent

Поддерживаю: 4 месяца писать комментарии - никуда не годится.

#5

Updated by Sergey Smolov almost 5 years ago

  • Subject changed from [comments] Коментарии к коду to [comments] Комментарии к коду
#6

Updated by Alexander Protsenko almost 5 years ago

  • Status changed from New to Resolved

Все замечания к коду проекта на данный момент исправлены.

Код приведен к стилю: eclipse-java-google-style.xml

#7

Updated by Sergey Smolov almost 5 years ago

  • Status changed from Resolved to Closed
  • Published in build set to 20141230

Also available in: Atom PDF