В каком порядке вы помещаете методы в код класса?

Question

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

Как вы группируете функции в коде класса, чтобы сделать его читаемым? Что такое лучшие практики?

Спасибо.

Answer 1

Вот как я делаю это для классов Java:

1. Конструкторы
2. публичные методы из реализованных интерфейсы
3. открытые методы переопределены или методы объявлены как абстрактные расширенные классы (не Object, см. ниже)
4. публичные методы (кроме метод получения / установки / методы объекта)
5. геттеры и сеттеры, в порядке объявлен объект недвижимости
6. равно, hashCode и toString
7. частные методы
8. публичные статические методы

Answer 2

Одно соглашение не должно подходить для всех сценариев - обычно в нашей команде мы используем C # и используем «регион» для группировки частных полей, статических членов, частных методов, конструкторов, защищенных методов и открытых методов.Порядок не имеет большого значения, потому что VS может хорошо развалить все регионы, давая общее представление.Иногда мы также используем «переопределения» и / или «виртуальные» регионы.Это также зависит от сложности рассматриваемого класса.Для нескольких сложных классов вы даже найдете регионы, основанные на функциональности.Например, все «парсинговые» вещи (переменные, приватные методы, публичные методы, участвующие в парсинге) будут вместе в одном регионе.В конце, цель состоит в том, чтобы иметь читаемый (поддерживаемый) код, и «согласованность» была бы одним из инструментов для этого - пока команда понимает это, не должно быть никаких проблем.