Мотивация
Непонятны варианты параметров функций API фасадов из-за чего приходится лезть в кишки модулей, что по идее должно предотвращаться из-за самого существование API фасадов и их функций.
Решение
Нужно в функциях API фасадов (содержимое presentation.periphery.facade) документировать их параметры при помощи Doc.
Информация, выраженная в описаниях Doc, должна оповещать о вариантах входного значения для валидного и невалидного выполнения функции.
Порты - клиенты, которые обращаются к фасадам для доступа к другим модулям документировать не нужно.
Заблокировано по #35.
Мотивация
Непонятны варианты параметров функций API фасадов из-за чего приходится лезть в кишки модулей, что по идее должно предотвращаться из-за самого существование API фасадов и их функций.
Решение
Нужно в функциях API фасадов (содержимое
presentation.periphery.facade) документировать их параметры при помощиDoc.Информация, выраженная в описаниях
Doc, должна оповещать о вариантах входного значения для валидного и невалидного выполнения функции.Порты - клиенты, которые обращаются к фасадам для доступа к другим модулям документировать не нужно.
Заблокировано по #35.