Skip to content

VBA XML Comments to Github wiki pages tool

Sergey Frolov edited this page Sep 3, 2020 · 2 revisions

Tool for generating Github markdown wiki-pages from VBA modules which contain XML comments.

Based on Microsoft recommendations for documenting VBA code.

Tool

Instructions:

  1. Choose the folder with files exported from VBA project which contain XML Comments. You can export VBA-files manually, or using VBA-tools like https://rubberduckvba.com/
    Current folder of this file will be used by default

  2. Choose target folder where *.md wiki-files will be stored.
    Wiki-file names will be in format source_vba_file.ext.md (i.e. Main.bas -> Main.bas.md)
    Folder from action #1 will be used by default

  3. Press Extract XML comments button to extract the comments to wiki-files.

  4. Open target folder by clicking to the link generated after extraction.

  5. Copy wiki-pages to your GitHub-project wiki-folder https://www.github.com

Notes:

  • Install any snippet tools for using XML-Comments templates into your VBA code.
    For example, it can be any tool with hot-key replace function like MZ-Tools or Mahou

  • IMPORTANT! You can use templates from XMLCommentTemplates sheet, OR change the VBA-code in Class modules to parse your own templates.

Clone this wiki locally