Checkstyle конфликтует с Oracle Java Style Guide - PullRequest
Новая
       7

Checkstyle конфликтует с Oracle Java Style Guide

0 голосов
/ 14 февраля 2012

Я прохожу курс, требующий использования Checkstyle. Я довольно озадачен «конвенциями», которые, кажется, принуждают.

Например: 

/**
 * Something, something.
 *                        <-- NOT ALLOWED
 * @param bla bla bla
 */

Тернарный оператор вообще не разрешен, и для каждого оператора if требуются скобки.

Похоже, что эти "соглашения" противоречат принципам стиля Oracle: http://www.oracle.com/technetwork/java/codeconv-138413.html

Я понял, что идей о стилях почти столько же, сколько и программистов, но откуда взялся этот набор правил и есть ли какое-то особое преимущество в правилах Checkstyle?

1 Ответ

0 голосов
/ 14 февраля 2012

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

Но суть в том, что существует множество мнений по поводу стиля и макета Java, и вам просто нужно соблюдать правила, которые навязаны вам вашим курсом ... и в будущем вашим руководителем проекта, и так далее.

Я вижу аргументы для тех конкретных примеров правил:

  • Пустая строка в javadoc - пустая трата экранного пространства
  • Тернарный оператор имеет тенденцию использоваться в местах, которые делают код менее читабельным.
  • Дисциплина, состоящая в постоянном использовании '{' '}' с if операторами и телами циклов, позволяет избежать сценария, в котором ошибки скрываются из-за непоследовательного отступа. (С установленными скобками несоответствие становится более очевидным.)
...