Какая особенность наиболее важна для хорошего рутины?

Question

Подпрограммы, процедуры, методы - как бы вы их ни называли, они являются важными строительными блоками для нас, разработчиков. Какую отдельную характеристику вы бы оценили как самый важный один?

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

Answer 1

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

Answer 2

Из названия процедуры вы можете сказать, что делает процедура (и когда вы проверяете код, вы понимаете, что были правы;

Answer 3

Я думаю, что на этот вопрос легче ответить, если вы рассматриваете подпрограммы как часть API. Есть не так много процедур, которые стоят отдельно, по крайней мере, в действительно полезной системе. Так что, честно говоря, я думаю, что наиболее важные вещи, которые следует учитывать при написании процедур:

1. Интуитивность Насколько интуитивен мой набор инструкций - поймут ли люди цель без необходимости разбираться с большим количеством документации?

2. Ортогональность Насколько ортогональны мои процедуры? Каждый из них выполняет одну конкретную задачу, или есть несколько (но немного разных) способов сделать одно и то же? Если это так, это плохо, и API, вероятно, нуждается в переработке.

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

Answer 4

Ясность - Легко понять

Answer 5

Строки кода.

Answer 6

Вы должны отслеживать количество правок, необходимых после того, как процедура была введена в действие. «Хорошая» рутина - это та, в которой требуется несколько правок. «Плохая» рутина определенно подтверждается, когда требуется куча исправлений.

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

Answer 7

Я бы сказал, хорошо документированные (и фактически соблюдаемые) условия до и после.

Answer 8

Он выполняет одну функцию или делегирует несколько функций другим функциям

Answer 9

Должно быть атомным

Answer 10

Одна точка возврата