Visual Studio extension for rich inlined comments using MarkDown
C# F# CSS HTML JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
MDComment
MDFormatter
signed_lib
.gitattributes
.gitignore
Elucidate.sln
README.md

README.md

Elucidate

A Visual Studio extension that allows you to comment code using MarkDown, resulting in code that is interleaved with rich text, pictures and hyperlinks.

To use:

  1. Install "Elucidate" from the Visual Studio gallery.
  2. Create either a markdown file (.md) or an F# script file (.fsx - example) using MarkDown and literate scripting from FSharp.Formatting
  3. Open "View --> Other Windows --> Elucidate". Save the script file.

The Elucidate window should update with the rendered markdown. You may have to move in/out of the script window (Elucidate updates when the Elicudate window is open, and a script document is activated and then saved)

Elucidate was inspired by Donald Knuth's literate programming. Although it falls short of that ideal, the ability to anotate code with references and pictures aids in a better understanding of the code at hand. From my experience external code documentation is rarely created and consulted even less. The best place to document code is in the code. Unfortunately traditional comments falls short of allowing programmers to elaborate on the design. Sometimes a simple picture says a thousand words. The ability to link to other parts of the documentation is also key. As programmers we spend much more time reading code, than writing code. We should make this activity as effortless as possible for our fellow programmers.