https://github.com/cbinet/autodocumentation
Csharp to Markdown autodocumentation library.
https://github.com/cbinet/autodocumentation
auto-generated csharp documentation generated markdown
Last synced: 9 months ago
JSON representation
Csharp to Markdown autodocumentation library.
- Host: GitHub
- URL: https://github.com/cbinet/autodocumentation
- Owner: CBinet
- Created: 2017-06-24T21:54:47.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-12T23:01:03.000Z (over 8 years ago)
- Last Synced: 2025-07-09T21:35:32.243Z (9 months ago)
- Topics: auto-generated, csharp, documentation, generated, markdown
- Homepage: https://www.nuget.org/packages/BetaSoftware.AutoDocumentation
- Size: 9.38 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AutoDocumentation
## **Installation**
To install **AutoDocumentation**, you can either browse the Package Manager or run the following command in the Package Manager Console :
```
PM> Install-Package BetaSoftware.AutoDocumentation
```
## **Usage**
To start using **AutoDocumentation**, simply call the GenerateDocumentation method of the **AutoDocumentation** class with the project assembly :
```cs
var assembly = Assembly.LoadFrom(pathToDll); // Load the assembly.
BetaSoftware.AutoDocumentation.GenerateDocumentation(assembly);
```
To include all private and internal types in the generated documentation, call the GenerateDocumentation method with **false** as the second parameter :
```cs
var assembly = Assembly.LoadFrom(pathToDll); // Load the assembly.
BetaSoftware.AutoDocumentation.GenerateDocumentation(assembly, false);
```
### Settings attributes
You can customize the content that will appear in your generated documentation
with the **AutoDocumentation** attributes :
#### AutoDocumentationIgnore
Add to exclude a type from documentation generation :
```cs
[AutoDocumentationIgnore]
public class IgnoredClass {
...
}
```
## **Examples : Interface documentation**
```cs
namespace DemoLibrary {
public interface IFormattable {
string FormatInformations();
}
}
```
DemoLibrary.IFormattable
Methods :
public abstract String FormatInformations()
## **Examples : Class documentation**
```cs
namespace DemoLibrary {
public class Employee : IFormattable {
public int Id;
public string Name;
public Address Address;
public Department Department;
public Employee(int pId, string pName,
Address address, Department department) {...}
public string FormatInformations() {...}
}
}
```
DemoLibrary.Employee : IFormattable
Fields :
public Int32 Id
public String Name
public Address Address
public Department Department
Constructors :
public Employee(Int32 pId, String pName, Address pAddress, Department pDepartment)
Methods :
public String FormatInformations()
## **Examples : Struct documentation**
```cs
namespace DemoLibrary {
public struct Address {
public int DoorNumber;
public string StreetName;
public string City;
public string PostalCode;
}
}
```
DemoLibrary.Address Fields :
public Int32 DoorNumber
public String StreetName
public String City
public String PostalCode
## **Examples : Enum documentation**
```cs
namespace DemoLibrary {
public enum Department {
Sales,
Marketing,
HumanResources
}
}
```
DemoLibrary.Department
Values :
0 : Sales,
1 : Marketing,
2 : HumanResources