Как использовать ctags для документации кода

Question

У меня есть исходный код, который я хочу документировать, не касаясь кода. Для каждого исходного файла (например, example.cpp, example.f90 и т. Д.) Я хотел бы иметь отдельный файл документации (например, example.cpp.doc, example.f90.doc), который содержит некоторые метаданные (ctag), связывающие его с исходным исходным файлом.

В идеале я мог бы открыть исходный файл и файл документации в виде параллельных представлений в моем любимом редакторе (ViM) и синхронизировать два файла, чтобы они прокручивались вместе. Таким образом, я могу поддерживать визуальную визуальность моей документации с помощью не затронутого исходного кода.

Я знаю, что это может быть уникальный сценарий. Но я надеюсь, что кто-то еще это понял.

Возможно ли это?

Answer 1

Создайте исходную .doc-структуру вне Vim, чтобы «метаданные», которые вы хотите сохранить, находится в том же номере строки, что и исходный файл.

Затем откройте два файла в разных окнах Vim с помощью vim -O example.cpp example.cpp.doc. В этот момент используйте :windo set scrollbind, чтобы включить привязку прокрутки, что позволит перемещаться по любому из окон, сохраняя при этом синхронизацию.