The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning. Learn more →
Top 13 C# Documentation Projects
-
WorkOS
The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.
-
Sandcastle
Sandcastle Help File Builder (SHFB). A standalone GUI, Visual Studio integration package, and MSBuild tasks providing full configuration and extensibility for building help files with the Sandcastle tools.
-
SourceBrowser
Source browser website generator that powers http://referencesource.microsoft.com and http://sourceroslyn.io
-
PowerDocu
Generate technical documentation from your existing Power Automate Flows and Power Apps canvas apps
-
DocNet
Your friendly static documentation generator, using markdown files to build the content. (by FransBouma)
-
InfluxDB
Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
-
ModularDoc
Modular documentation generator for .NET libraries. Currently supporting Markdown only for GitHub, GitLab, and Bitbucket
Project mention: Added Physics to my enemies - Unity DOTS. Pretty happy with the result! Time to tweak | /r/Unity3D | 2023-05-25Sure. This is the repo. It contains more than Physics
Project mention: TSDocs.dev: type docs for any JavaScript library | news.ycombinator.com | 2023-12-19This is a better looking version of what Java and C# have had for a long time (kudos to the author for that!), is that the inspiration for this tool?
https://docs.oracle.com/javase/8/docs/technotes/tools/window...
https://dotnet.github.io/docfx/
I saw the author mentioned in another comment that they found themselves peeping inside type declaration files "too often". While I do often use sites generated by the above tools to discover new API's that suit my needs, diving into the actual code using a good decompiler is still my first move, as it is often cheaper than seeking out the documentation online, and it will show me the actual implementation as well. So in my opinion there is no shame in looking inside the declaration files!
An easy to use documentation tool is Sandcastle Help File Builder. Sandcastle can be used as a standalone tool or integrated directly into Visual Studio. After a new language extension is written and tested use Sandcastle to create a help file. The learning curve is short and is unforgiving in that it will report when elements of documentation is missing beginning at class level down to method descriptions and parameter information.
C# Documentation related posts
- DevDocs
- Microsoft Entity Framework Core 8 samples
- Use Case Driven Development with Low-Code
- Azure AD - How to have a Distributed Token Cache per tenant?
- Anybody know if there's a library for the doc engine that MS Docs/Learn uses?
- C# Language extensions
- What is the best way to document classes?
-
A note from our sponsor - WorkOS
workos.com | 19 Apr 2024
Index
What are some of the best open-source Documentation projects in C#? This list will help you:
Project | Stars | |
---|---|---|
1 | EntityComponentSystemSamples | 6,804 |
2 | DocFX | 3,880 |
3 | Swashbuckle | 3,057 |
4 | Sandcastle | 2,169 |
5 | SourceBrowser | 1,033 |
6 | PowerDocu | 367 |
7 | DocNet | 245 |
8 | NaturalDocs | 187 |
9 | DefaultDocumentation | 152 |
10 | PSDocs | 135 |
11 | ModularDoc | 95 |
12 | dotnet-document | 92 |
13 | IPS-Peek | 46 |