Tip

The docs as explained here are used in multiple projects, but documented only once for better maintenance. When applying this to other projects, remember that some things such as the name, repository, or paths are a bit different.

🌴 2sxc: Docs Repo, Docs Live
🩸 Oqtane: Docs Repo, Docs Live
♾️ cre8magic: Docs Repo, Docs Live

Document Code

Basic Documentation

Add normal documentation with /// <summary> tags to your code, like this:

/// <summary>
/// Constructor which does xyz
/// </summary>
/// <param name="id">the id</param>
public MyMethod(int id) { }

All this is automatically picked up and converted to documentation.

Referencing Other Classes

If you want to reference other classes, you can use the <see cref="..."/> tag:

/// <summary>
/// This method uses the <see cref="Oqtane.Example.MyClass"/> to do something.
/// </summary>
public void MyMethod() { }

Referencing Other Methods

You can also reference other methods:

/// <summary>
/// This method uses the <see cref="MyMethod"/> to do something.
/// </summary>
public void MyMethod() { }

Referencing Other Docs

If you want to reference other docs, you can use the [xxx](xref:UID) tag:

/// <summary>
/// This method uses the [Xyz Conventions](xref:Pages.Conventions.Xyz) to do something.
/// </summary>
public void MyMethod() { }

Using Markdown in C# Docs

You can also use markdown in your C# docs, like this:

/// <summary>
/// This method is **great** for `null`.
///
/// Here is a list:
/// 1. Do this
/// 1. Then that
/// </summary>
public void MyMethod() { }

Main Author

Daniel Mettler, `@iJungleboy` [MS MVP, DNN & Oqtane Core Team]

Content Management Expert, Chief Architect of 2sxc and cre8magic.
Forged in the jungles of Indonesia, lives in Switzerland , loves DNN ☢️, Oqtane 🩸 & 2sxc 💜.

Microsoft MVP | LinkedIn | Discord: @iJungleboy | Twitter: @iJungleboy | Github: @iJungleboy

Table of Contents

Tip