Некоторые виды комментариев в программировании:

• Поясняющие комментарии. 1 Помогают объяснить выбор конкретных алгоритмов или принятые компромиссы, а также почему не использовали более очевидный код. 1
• Документирующие комментарии. 1 Нужны для создания формальной документации, которая может быть автоматически сгенерирована в виде отдельных документов или встроена в код. 1 Такие комментарии описывают общие принципы работы, структуру и основные функции программы. 1
• Отладочные и временные комментарии. 1 Используются, когда в коде есть места, которые требуют доработки или улучшения в будущем. 1 Например, #TODO (планирование рефакторинга), #FIXME (исправление проблем), #Warning (осторожный запуск), #Error (обозначение ошибки). 1
• Аннотации. 24 Применяются в набросках доказательств правильности программ. 2 Такие комментарии описывают состояние компьютера, когда программа в процессе выполнения достигнет точки, где расположен комментарий. 2