OneOfBestMan / best-form

The best form of documentation is the code itself

Home Page:https://louthy.github.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

best form

The best form of documentation is the code itself

This is a C# doc-gen tool

  • Parses C# source code to extract the XML documentation as well as a fully tokenised structure of the code itself
  • Provides a virtual DOM that is actually a reader monad to project the tokenised structure into HTML markup
  • Generates doc-pages that look very much like the .NET Core docs

See the language-ext API reference for a demo of this tool

About

The best form of documentation is the code itself

https://louthy.github.io

License:MIT License


Languages

Language:C# 94.6%Language:CSS 4.9%Language:Batchfile 0.5%