• конкретная задача должна выполняться одним и только одним способом, то есть на стороне потребителя не должно быть выбора между вариантами обращения к программному интерфейсу — для выполнения конкретной частной задачи правильный вариант должен быть единственным.
2. Полная обратная совместимость:
• никакие изменения и обновления в нашем программном коде не должны приводить к ошибкам и даже к изменению поведения на стороне потребителя — единожды где-то написанный вызов нашего программного интерфейса должен оставаться работоспособным и предсказуемым все время, пока соответствующий экспортный метод существует в нашем коде.
3. Полная и актуальная документация:
• каждый экспортный метод, включенный в состав программного интерфейса, должен быть подробно документирован прямо по месту;
• технический заголовок метода должен включать в себя подробное описание — для чего предназначен метод, существуют ли какие-либо технические особенности работы с ним (режим транзакции, перехват исключений и так далее) и подробное описание всех параметров метода;
• документация должна быть настолько полной, что на стороне потребителя при работе с методом не потребуется заглядывать в его реализацию.
4. Лаконичность и осмысленность имен:
• имена методов программного интерфейса должны как минимум полностью соответствовать требованиям, изложенным в стандарте #647 «Имена процедур и функций»61.
5. Логичность и компактность параметров:
• программный интерфейс каждого отдельно взятого экспортного метода, то есть состав и возможные комбинации параметров метода, должен соответствовать принципу соразмерности (см. раздел «Отдельно стоящий метод» выше в этой главе).
Кіру не тіркелу пікір қалдыру үшін