Декларации Java (упорядочивание)

Question

В Java, как правило, наиболее приемлемый способ организации класса с точки зрения порядка, в котором объявленные члены данных и методы должны быть перечислены в файле класса, с учетом следующего и всего, что вы можете придумать для каждого один:

• его видимость
• будь то конструктор, метод или член
• если это метод, перегружает ли он или переопределяет другие методы?

Answer 1

Я обнаружил, что соглашения в Кодовые соглашения для языка программирования JavaTM вполне подходят. Глава 3 отвечает на этот вопрос.

В основном игнорируется видимость или перегружена ли функция и т. Д.

Это просто по порядку:

• Класс (статические) переменные
• Переменные экземпляра
• Конструктор
• Методы

Можно использовать более строгий подход, но я не вижу веского аргумента в его пользу.

Answer 2

Существуют рекомендуемые лучшие практики, и те, которые упоминает Крис, в значительной степени являются "стандартным" стандартом, с внутренними классами в нижней части этого списка.
Тем не менее, если вы используете Intellij IDEA (есть бесплатная версия для сообщества), есть плагин под названием Rearranger , который позволяет вам указать все это и обеспечить его выполнение, и что более важно рефакторинг существующий код будет таким, каким вы думаете, должен быть.

Answer 3

Eclipse (и, я уверен, другие IDE) автоматически упорядочит объявления (Source -> Sort Members) с опциями для типов и видимости. Перегрузка и переопределение недоступны, по крайней мере, в Eclipse. Поэтому я бы сказал, что нужно создать соглашение, которое включает тип и, возможно, видимость, но не статус перегрузки / переопределения, а затем настроить IDE вашей команды для применения этого соглашения. Автоматизируемые - и автоматизированные - стандарты намного легче для команды.

Answer 4

Вы можете следовать рекомендации, используемой проектом Google GWT, если хотите. Он основан на стандартных соглашениях Java-кода от Sun. Он добавляет некоторые строгие правила при оформлении заказа, также касающиеся модификаторов видимости и т. Д.

http://code.google.com/webtoolkit/makinggwtbetter.html#codestyle