itsametuni / code2md Goto Github PK
View Code? Open in Web Editor NEWA documentation generator for C# projects
License: BSD 2-Clause "Simplified" License
A documentation generator for C# projects
License: BSD 2-Clause "Simplified" License
This is the basic code structure for the rewrite
MarkdownBuilder
-> Helper class to build a string with markdown contents. The same as the current MarkdownHelper.MarkdownGenerator
-> Class that will be in charge of generating the markdown pages using the reflection and XML data provided.ReflectionToText
-> (static) class that will have helper methods used to convert reflection data into text (such as gathering modifiers, cleaning up the type names, etc)DataGatherer
-> Class that will be in charge of gathering and joining together the data obtained through reflection and XMLUtils
-> (static) class that has miscellaneous helper methods that don't belong anywhere else (like a method for string cleaning)TemplateParser
- > class responsible for parsing the supplied template.TemplateReplacer
-> class that will be in charge of replacing the supplied parsed template with the data passed to it by the MardownGenerator. Basically replacing the template tags with data gathered about the project.XmlData
-> contains the contents of all possible XML tags as string fields.TypeData
-> contains information about a type such as it's TypeData, lists of children fields, properties and methods, XmlData.MethodData
-> contains information about a method such as it's XmlData, list of parameters data, MethodInfo.PropertyData
-> contains information about a property such as it's XmlData, PropertyInfo.ParameterData
-> contains information about a parameter such as it's ParameterInfo and description (one string).FieldData
-> contains information about a field such as it's FieldInfo and XmlData.When the type is a 2D array like string[][]
the type name will be incorrect (missing a pair of [], type name as String
instead of string
) in the generated markdown.
There should be a configuration file that serves as a template for the generated output. code2md will then grab that template and replace some tags (like $method_signature$
) with the data it got from the XML documentation and from the assembly. This would allow a lot more control over the generated markdown and would enable the user to customize it however he/she wants.
For example:
Here the user chose to add an html tag e
with the highlight-type
class which will be picked up by some HTML/CSS/Javascript wizardry and color it according to its contents.
# $class_name$
## Fields
Type | Name | Description
-----------------------------------------------|:----------------:|------------
<e class="highlight-type">$parameter_type$</e> | $parameter_name$ | **Summary:** $parameter_summary$ **Remarks:** $parameter_remarks$
## Methods
### **$method_signature$**
**Summary:** $method_summary$
**Remarks:** $method_remarks$
...
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.