Программирование комментариев , также известное как разработка на основе комментариев (CDD), представляет собой (в основном) сатирическую технику разработки программного обеспечения , которая в значительной степени основана на комментировании кода. [1]
В программировании комментариев теги комментариев не используются для описания того, что делает определенный фрагмент кода, а скорее для остановки выполнения некоторых частей кода. Цель состоит в том, чтобы иметь закомментированный код в распоряжении разработчика в любое время, когда он может понадобиться. Это особенно полезно, когда требования быстро меняются. В этом случае они возвращаются к более старым версиям самих себя, заставляя программиста либо писать код заново, либо возвращать части кода из репозитория управления версиями, что займет больше времени. При программировании комментариев, когда возникает такой запрос на возврат к старой реализации, разработчик просто комментирует текущую реализацию и раскомментирует предыдущую. Целесообразно добавлять короткие описательные комментарии к блокам закомментированного кода.
Когда дело касается рабочей среды, дело не в том, кто знает больше терминов из учебника. Вместо этого мы сталкиваемся с проблемами, которые не уверены, как решить. Когда кто-то другой читает программу пользователя, для него важно понять, как проблема была решена, а не просто увидеть ответ. Даже если кто-то решит заняться чем-то другим, кроме компьютерного программирования, он будет хорошо вооружен привычкой комментировать и показывать другим, как он думал и решал конкретные проблемы. [2]
Связанное, но отдельное, более практическое использование комментариев — создание заглушек с комментариями, описывающими функцию (обычно с использованием специальных тегов ) перед будущей разработкой этой функции. Например, этот процесс программирования может использоваться для прототипирования нового шаблона проектирования . Это делается путем создания новой структуры классов или функций без какой-либо реализации и добавления реализации позднее.
Исследования показывают, что в программах в основном используются два типа комментариев. Предусловия и Постусловия — две самые важные идеи, которые программисты должны использовать при разработке проектов. Предусловия появляются до того, как была написана функция или метод. Они используются для описания того, что должен делать каждый блок кода. Это может направить пользователей в правильном направлении, если кто-то пытается отладить или проанализировать код. Постусловные комментарии используются после того, как была написана функция или набор операторов. Они обычно используются для объяснения читателю, почему он решил подойти к проблеме именно таким образом. [3]
Пример псевдокода:
function onClick () { // Здесь мы обрабатываем щелчок мыши. // Результатом этой функции является выделение кнопки. } В примере есть структура вокруг обработчика событий щелчка . Однако вместо реальной реализации используется программирование комментариев. Идея заключается в том, что многие функции могут быть написаны таким образом, а затем дизайн может быть переработан и пересмотрен без необходимости рефакторинга большого количества исходного кода .
MSDN Sweden подготовила видеоролик ко Дню смеха 2010 года, в котором они сатирически представили CDD, как будто это серьезная методология. [4]
MCT — это инструмент, созданный для программистов, чтобы помочь облегчить некоторую сложность компьютерного кода. Вместо обычных комментариев этот инструмент позволяет добавлять видео, анимацию, изображения и закадровый голос. Пользователи могут загрузить это программное обеспечение онлайн и добавлять эти инструменты, используя курсор для перетаскивания по строке или строкам, которые они хотят объяснить. Пользователи также могут добавлять аудио или жесты рук в качестве комментариев. Это может помочь объяснить обоснование функций и то, как выполняется программа. [5]