What is the best way to document classes?

This page summarizes the projects mentioned and recommended in the original post on /r/csharp

Our great sponsors
  • InfluxDB - Power Real-Time Data Analytics at Scale
  • WorkOS - The modern identity platform for B2B SaaS
  • SaaSHub - Software Alternatives and Reviews
  • 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.

  • Like already mentioned, use XML comments for everything possible. The class itself, enumerations, methods. In the Build or Compile properties (depends on the version of VS.NET) of your project, enable Generate XML documentation. I then personally use Sandcastle Help File Builder to create a help file from those.

  • ConsoleMenuSystem

  • 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.

    InfluxDB logo
  • doxygen

    Official doxygen git repository

  • Then use a program (such as docgen) to generate documentation from that.

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts