Comment utiliser ctags pour la documentation de code

Question

J'ai un code source que je veux documenter sans toucher au code. Pour chaque fichier source (par exemple, example.cpp, example.f90, etc.) J'aimerais disposer d'un fichier de documentation distinct (par exemple, example.cpp.doc, example.f90.doc) qui contient des métadonnées (ctag) qui le lient au fichier source d'origine.

Idéalement, je pouvais ouvrir le fichier source et le fichier de documentation dans des vues parallèles dans mon éditeur favori (ViM) et faire synchroniser les deux fichiers afin qu'ils défilent ensemble. De cette manière, je peux garder ma documentation visuellement en ligne avec le code source non-touché. Je sais que ceci est susceptible d'être un scénario unique. Mais j'espère que quelqu'un d'autre a déjà compris cela.

Est-ce encore une possibilité?

Answer 1

Créez la structure .doc initiale en dehors de Vim de sorte que les «métadonnées» que vous souhaitez conserver se trouvent dans le même numéro de ligne que le fichier d'origine. Puis ouvrez les deux fichiers dans différentes fenêtres Vim avec vim -O example.cpp example.cpp.doc. À ce stade, utilisez :windo set scrollbind pour activer la liaison par défilement, ce qui vous permettra de naviguer dans l'une des fenêtres tout en conservant les deux synchronisés.