Стиль кодирования Java - PullRequest
       11

Стиль кодирования Java

8 голосов
/ 28 апреля 2010

Как вы соблюдаете стандарты кодирования? Существует stylecop и resharper для C #. Существуют ли какие-либо инструменты / плагины затмения для анализа кода в Java? Какие из них вы используете?

Ответы [ 9 ]

11 голосов
/ 28 апреля 2010

Checkstyle - инструмент разработки, помогающий программистам писать код Java, соответствующий стандарту кодирования. Он автоматизирует процесс проверки кода Java, чтобы избавить людей от этой скучной (но важной) задачи. Это делает его идеальным для проектов, которые хотят обеспечить соблюдение стандарта кодирования. Checkstyle легко настраивается и может поддерживать практически любой стандарт кодирования. Прилагается пример файла конфигурации, поддерживающего соглашения Sun Code Conventions. Кроме того, другие примеры файлов конфигурации предоставляются для других хорошо известных соглашений.

PMD интегрирован с JDeveloper, Eclipse, JEdit, JBuilder, BlueJ, CodeGuide, NetBeans / Sun Java Studio Enterprise / Creator, IntelliJ IDEA, TextPad, Maven, Ant, гелем, JCreator и Emacs.

FindBugs использует статический анализ для проверки байт-кода Java на наличие шаблонов ошибок. Статический анализ означает, что FindBugs может находить ошибки, просто проверяя код программы: выполнение программы не является необходимым. Это делает FindBugs очень простым в использовании: в общем, вы должны иметь возможность использовать его для поиска ошибок в вашем коде в течение нескольких минут после его загрузки. FindBugs работает путем анализа байт-кода Java (скомпилированные файлы классов), поэтому вам даже не нужен исходный код программы для его использования. Поскольку его анализ иногда неточен, FindBugs может сообщать о ложных предупреждениях, которые являются предупреждениями, которые не указывают на реальные ошибки. На практике частота ложных предупреждений, сообщаемых FindBugs, составляет менее 50%.

5 голосов
/ 28 апреля 2010

Checkstyle и FindBugs и PMD . Последние два гораздо больше, чем просто инструменты стиля. Но обычно необходимо приложить некоторые усилия, чтобы договориться между членами команды, а также для настройки инструмента.

4 голосов
/ 28 апреля 2010

Вы можете взглянуть на Сонар . Это проект с открытым исходным кодом, который действительно облегчает выполнение Checkstyle, PMD и Findbugs.

4 голосов
/ 28 апреля 2010

В дополнение к вышесказанному, Jalopy является хорошим инструментом для форматирования кода.

4 голосов
/ 28 апреля 2010

Я использую Checkstyle , чтобы убедиться, что код соответствует определенным правилам. Checkstyle также доступен как плагин для Eclipse.

2 голосов
/ 28 апреля 2010

Что плохого в самодисциплине? Если вы не можете сделать это для чего-то столь же тривиального, как форматирование, я не оставляю много надежд на другие аспекты качества кода.

0 голосов
/ 28 апреля 2010

Предупреждения компилятора eclipse и средство форматирования кода делают всю работу за нас. Хотя я знаю, что checkstyle делает немного больше семантической проверки для реального дизайна кода, а не просто выкладывает его разумно

0 голосов
/ 28 апреля 2010

Хорошим началом является документ о стандартах кодирования, который распространяется среди разработчиков в команде / отделе / ​​организации.

0 голосов
/ 28 апреля 2010

Мы используем Checkstyle в моей компании, хотя только для проверок Javadoc.

Приятно, что вы можете настроить различные модули для включения содержимого, которое нужно проверять, а также на каких уровнях (например, в защищенном, общедоступном, частном и т. Д.).

Суть в том, что для проверки javadoc вам необходимо явно указать, разрешено ли методу throw несколько исключений. Это так, потому что создатели считают, что плохой дизайн состоит в том, чтобы метод вызывал более одного исключения (другими словами, они пытаются управлять дизайном, не связанными с ИМХО).

...