Skip to content

Commenting Syntax

Stephen Roebuck edited this page Oct 17, 2017 · 9 revisions

Commenting Syntax

Currently CleanSlate supports the following Markdown Syntax:

Example-Code
Summary
Param
Returns

The syntax above should be formatted like this:
Inline tags are supported


Example-Code

///<example>
///This line would be where you place an explanation of the code tag.
///<code>
///This line is where you'd place your code.
///</code>
///</example>


Summary

///<summary>
///This is how a summary tag should be set up.
///</summary>


Param

///<param name="paramtag">
///This is how a parameter tag should be set up.
///</param>


Returns

///<returns>Explains what the function/method returns.<returns>

Clone this wiki locally