Добро пожаловать на реактор!
доки могут быть в виде примечаний в коде )
можно нормально называть процедуры и поля и будет понятно, что происходит и без документации, но это как правило слишком сложно и недостаточно интересно.
Я, в таких случаю, ищу Accepatance Criteria в тикете.
Если их нет заебую дева или лида чтоб написали и, пока их нет, тикет висит в "QA" статусе или возвращается в "In Progress" и я его не закрываю (пусть у них бошка болит за статистику, мол, слишком долго тикеты не закрываются и т.д.)
Если их нет заебую дева или лида чтоб написали и, пока их нет, тикет висит в "QA" статусе или возвращается в "In Progress" и я его не закрываю (пусть у них бошка болит за статистику, мол, слишком долго тикеты не закрываются и т.д.)
Зачем вообще документация? Что бы на твое место взяли кого-то другого?
Документация... Как много в этом слове.
Вообще, по-нормальному, документация по фиче пишется ДО кода, и не в коде. А в какой-то хуйне для документации. Там описана, собственно, суть фичи. По желанию, после имплантации, может быть добавлена короткая шпаргалка, куда смотреть в код, основные точки входа.
Документация же в коде - дичь. Она нужна только если код - хуевый. Нормальный код читается и без всякого мусора. Особенно вот этого "гет блять юзер нейм". Можно писать комментарии на неочевидные моменты, на дичь, которая там "по историческим причинам", и всякое такое. Нормальному же коду мусор в виде дублирования в документации нахуй не всрался.
Вообще, по-нормальному, документация по фиче пишется ДО кода, и не в коде. А в какой-то хуйне для документации. Там описана, собственно, суть фичи. По желанию, после имплантации, может быть добавлена короткая шпаргалка, куда смотреть в код, основные точки входа.
Документация же в коде - дичь. Она нужна только если код - хуевый. Нормальный код читается и без всякого мусора. Особенно вот этого "гет блять юзер нейм". Можно писать комментарии на неочевидные моменты, на дичь, которая там "по историческим причинам", и всякое такое. Нормальному же коду мусор в виде дублирования в документации нахуй не всрался.
Вот вам структура джейсончика, тестите через постман пока не получится.
String GetUserName()