Documentation

Doc Extraction

These extract API documentation in HTML and other formats from code comments.

• Swagger - for REST APIs based on the OpenAPI Specification.
• Doxygen (C, C++, C♯, D, Fortran, IDL, Java, Objective-C, Perl, PHP, Python, Tcl, and VHDL)
  • Modern C++ doc stack: Doxygen, Sphinx, Breathe, Exhale
• GhostDoc (C#, Visual Basic, C++/CLI, JavaScript)
• Javadoc (Java)
• Godoc (Go)
• Rustdoc (Rust)
• pdoc (Python)

Code Visualization

• Emerge - Graph-based code visualization in the browser

Architecture as Code

Some teams prefer to maintain design diagrams as text in source control so they can more easily be kept up to date.

• C4 Model
• Structurizr
• PlantUML
• MermaidJS