Что такое самодокументированный код и может ли он заменить хорошо документированный код? [закрытый]
У меня есть коллега, который утверждает, что его код не нуждается в комментариях, это "нагляден."
Я просмотрел его код, и хотя он яснее, чем код, который я видел у других, я все еще не согласен с тем, что самодокументированный код является таким же полным и полезным, как и комментируемый и документированный код.
помогите мне понять его точки зрения.
- что такое самостоятельное документирование кода
- может ли он действительно заменить хорошо прокомментированный и документированный код
- есть ли ситуации, когда это лучше, чем хорошо документированный и прокомментированный код
- есть ли примеры, когда код не может быть самодокументируемыми без комментариев
может быть, это просто мои собственные ограничения, но я не вижу, как это может быть хорошей практикой.
Это не должно быть аргументом-пожалуйста, не поднимайте причины, почему хорошо прокомментированный и документированный код имеет высокий приоритет - есть много ресурсы показывают это, но они не убедительны для моего сверстника. Я считаю, что мне нужно более полно понять его точку зрения, чтобы убедить его в обратном. Начните новый вопрос, если вы должны, но не спорьте здесь.
ого, быстрый ответ! Пожалуйста, прочитайте все существующие ответы и предоставьте комментарии к ответам, а не добавляйте новые ответы, если ваш ответ действительно существенно отличается от любого другого ответа здесь.
кроме того, те из вас, кто спорит против самодокументирования кода-это в первую очередь поможет мне понять перспективу (т. е. положительные аспекты) самодокументирования кода евангелистов. Я ожидаю, что другие будут понижать вас, если вы не останетесь на тему.
Comments