Atc.CodeDocumentation.CodeComment.md

References  -  References extended

Atc.CodeDocumentation.CodeComment

CodeDocumentationTags

Represents the structured documentation data for code members, including summary, parameters, remarks, and examples.

public class CodeDocumentationTags

Properties

Code

Code

Summary: Gets or sets code usage examples.

Example

Example

Summary: Gets or sets code examples demonstrating usage.

Exceptions

Exceptions

Summary: Gets or sets the exception descriptions, mapped by exception type.

Parameters

Parameters

Summary: Gets or sets the parameter descriptions, mapped by parameter name.

Remark

Remark

Summary: Gets or sets additional remarks about the code member.

Return

Return

Summary: Gets or sets the description of the return value.

Summary

Summary

Summary: Gets or sets the summary description of the code member.

Methods

ToString

string ToString()

CodeDocumentationTagsGenerator

Generates formatted XML documentation comment tags from structured code documentation data.

public class CodeDocumentationTagsGenerator : ICodeDocumentationTagsGenerator

Methods

GenerateTags

string GenerateTags(ushort indentSpaces, CodeDocumentationTags codeDocumentationTags)

ShouldGenerateTags

bool ShouldGenerateTags(CodeDocumentationTags codeDocumentationTags)

ICodeDocumentationTagsGenerator

Defines methods for generating XML documentation comment tags from structured documentation data.

public interface ICodeDocumentationTagsGenerator

Methods

GenerateTags

string GenerateTags(ushort indentSpaces, CodeDocumentationTags codeDocumentationTags)

Summary: Generates formatted XML documentation comment tags from the specified documentation data.

Parameters:
     indentSpaces  -  The number of spaces to use for indentation.
     codeDocumentationTags  -  The code documentation tags to generate.

Returns: A string containing the formatted XML documentation comment tags.

ShouldGenerateTags

bool ShouldGenerateTags(CodeDocumentationTags codeDocumentationTags)

Summary: Determines whether XML documentation tags should be generated for the specified documentation.

Parameters:
     codeDocumentationTags  -  The code documentation tags to evaluate.

Returns: if tags should be generated; otherwise, .

---

Generated by MarkdownCodeDoc version 1.2