Исправление Deleted, (текущая версия) :
Пока код длинный — тот комментарий нужен, чтобы через год с первого взгляда понять, какие возвращаются переменные окружения и в каком порядке
Вот только когнитивная нагрузка возраскает многократно. Тебе надо не забывать менять докстринг при каждом изменении контракта. Тебе надо каждый раз перечитывать текст на человеческом. И все-равно IDE/компилер не сможет ничего почерпнуть из такого докстринга. Сизифов труд как он есть
А когда код короткий, то нет никакой разницы — читать код или комментарий, ведь по коду тоже всё сразу видно
В идеале, при наведении на имя функции, описанной в другом файле, IDE покажет тебе ее полную аннотацию (с разрезолвенными генериками, если удастся, и коментарием). А в твоем случае оно должно показать весь исходник?? Который ты будешь перечитывать до посинения??
Правильные для академической чистоты кода. Но решение они не упрощают
Нет. Именно упрощают. Если написать ***ню, то она потом аукнется и не раз
Исправление Deleted, :
Пока код длинный — тот комментарий нужен, чтобы через год с первого взгляда понять, какие возвращаются переменные окружения и в каком порядке
Вот только когнитивная нагрузка возраскает многократно. Тебе надо не забывать менять докстринг при каждом изменении контракта. Тебе надо каждый раз перечитывать текст на человеческом. И все-равно IDE/компилер не сможет ничего почерпнуть из такого докстринга. Сизифов труд как он есть
А когда код короткий, то нет никакой разницы — читать код или комментарий, ведь по коду тоже всё сразу видно
В идеале, при наведении на имя функции, описанной в другом файле, IDE покажет тебе ее полную аннотацию (с разрезолвенными генериками, если удастся, и коментарием). А в твоем случае оно должно показать весь исходник??
Правильные для академической чистоты кода. Но решение они не упрощают
Нет. Именно упрощают. Если написать ***ню, то она потом аукнется и не раз
Исходная версия Deleted, :
Пока код длинный — тот комментарий нужен, чтобы через год с первого взгляда понять, какие возвращаются переменные окружения и в каком порядке
Вот только когнитивная нагрузка возраскает многократно. Тебе надо не забывать менять докстринг при каждом имзенении контракта. Тебе надо читать текст на человеческом. И все-равно IDE/компилер не сможет ничего почерпнуть из этой информации. Сизифов труд как он есть
А когда код короткий, то нет никакой разницы — читать код или комментарий, ведь по коду тоже всё сразу видно
В идеале, при наведении на имя функции, описанной в другом файле, IDE покажет тебе ее полную аннотацию (с кразррезолвенными генериками, если удастся, и коментарием). А в твоем случае оно должно показать весь исходник??
Правильные для академической чистоты кода. Но решение они не упрощают
Нет. Именно упрощают. Если написать ***ню, то она потом аукнется и не раз