@makaleks

Какие есть проекты по извлечению разметки из специальных комментариев?

Не разбираюсь совсем. Хочу разделять комментарии в исходном коде на 'служебные' и 'для людей'. Например, с одной стороны в комментарии можно класть doxygen/grapviz и прочее для документации 'на месте', ну или обозначения и группировки узлов графа вызовов/типов/данных для 'самого важного для понимания'. И есть обычные комментарии, которые, например, поясняют посреди алгоритма неочевидный/сомнительный шаг или обозначение. Проблема в том, что служебные и человекочитаемые комментарии сливаются, так ещё и служебные комментарии могут быть разнотипные.

Похоже на потребность в (1) формате служебных комментариев, который и визуально отделит его от человекочитаемых комментариев, и покажет, в каком формате служебный комментарий написан (нет, аннотация в стиле markdown вида ```doxygen неудобна, хочется отделять чем-то вроде префикса --- на каждой строчке спец.коммента) и (2) препроцессоре служебных комментариев, который выбросит всё кроме целевого формата, чтобы в одном файле форматы сосуществовали по принципу 'перемешать, но не смешивать'.

И вот что-то такое специфическое попытался загуглить, и не нашёл. Интересует, (1) есть ли проекты под эту задачу, (2) есть ли субъективно удобная практика решения проблем разнородных комментариев иначе. Ну и наверное (3) где ещё можно на этот счёт поинтересоваться
  • Вопрос задан
  • 34 просмотра
Пригласить эксперта
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Похожие вопросы