Giter Club home page Giter Club logo

elucidate's Introduction

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.