C# Prettier Docs

A Visual Studio Code extension that makes your C# XML docs look just a tad bit nicer.

Features

alt text

(Mostly) Hides the default C# XML docs and replaces it with pretty text decorators.
Fully customizable styling and decorative marks.
Use the Toggle command to quickly enable/disable the extension.

Settings

Preset Example

JS Doc style

  "csharp-prettier-docs.general.opacity": 0.2,
  "csharp-prettier-docs.general.markers.blockPrefix": "/*",
  "csharp-prettier-docs.summary.style.fontWeight": 500,
  "csharp-prettier-docs.summary.markers.linePrefix": " * ",
  "csharp-prettier-docs.summary.markers.lineSuffix": "",
  "csharp-prettier-docs.param.markers.linePrefix": " * ",
  "csharp-prettier-docs.param.markers.namePrefix": "@param {",
  "csharp-prettier-docs.param.markers.nameSuffix": "}",
  "csharp-prettier-docs.param.markers.delimiter": " ",
  "csharp-prettier-docs.returns.markers.linePrefix": " * ",
  "csharp-prettier-docs.returns.markers.tag": "@returns ",
  "csharp-prettier-docs.returns.style.fontStyle": "normal",
  "csharp-prettier-docs.other.markers.linePrefix": " * @",
  "csharp-prettier-docs.other.markers.namePrefix": " {",
  "csharp-prettier-docs.other.markers.nameSuffix": "}",
  "csharp-prettier-docs.other.markers.delimiter": " ",

alt text

Configurations

Name	Description	Default
`csharp-prettier-docs.general.borderRadius`	Border radius of the background card	5
`csharp-prettier-docs.general.horizontalPadding`	Right and left padding of the background card	4
`csharp-prettier-docs.general.margin`	Margins for the background card	3
`csharp-prettier-docs.general.markers.blockPrefix`	Decorative mark placed before the comment block	""
`csharp-prettier-docs.general.opacity`	Opacity of the actual doc comment, out of 1.0	0.3
`csharp-prettier-docs.general.verticalPadding`	Top and bottom padding of the background card	1
`csharp-prettier-docs.other.markers.delimiter`	Decorative mark between the other tags' name and description	" -- "
`csharp-prettier-docs.other.markers.linePrefix`	Decorative mark placed before every other tags' line	" │ "
`csharp-prettier-docs.other.markers.lineSuffix`	Decorative mark placed after every other tag line	""
`csharp-prettier-docs.other.markers.namePrefix`	Decorative mark placed before the other tags' name	" "
`csharp-prettier-docs.other.markers.nameSuffix`	Decorative mark placed after the other tags' name	""
`csharp-prettier-docs.other.markers.textPrefix`	Decorative mark placed before the other tags' description	""
`csharp-prettier-docs.other.markers.textSuffix`	Decorative mark placed after the other tags' description	""
`csharp-prettier-docs.other.style.fontSize`	Font size for the other tags' decorator	14
`csharp-prettier-docs.other.style.fontStyle`	Font style for other tags' decorator	"normal"
`csharp-prettier-docs.other.style.fontWeight`	Font weight for the other tags' decorator	500
`csharp-prettier-docs.param.markers.delimiter`	Decorative mark between the param name and description	" -- "
`csharp-prettier-docs.param.markers.linePrefix`	Decorative mark placed before every param line	" │ "
`csharp-prettier-docs.param.markers.lineSuffix`	Decorative mark placed after every param line	""
`csharp-prettier-docs.param.markers.namePrefix`	Decorative mark placed before the param name	""
`csharp-prettier-docs.param.markers.nameSuffix`	Decorative mark placed after the param name	""
`csharp-prettier-docs.param.markers.textPrefix`	Decorative mark placed before the param description	""
`csharp-prettier-docs.param.markers.textSuffix`	Decorative mark placed after the param description	""
`csharp-prettier-docs.param.style.fontSize`	Font size for the params decorator	14
`csharp-prettier-docs.param.style.fontStyle`	Font style for param decorator	"normal"
`csharp-prettier-docs.param.style.fontWeight`	Font weight for the params decorator	500
`csharp-prettier-docs.returns.markers.linePrefix`	Decorative mark placed before every returns line	""
`csharp-prettier-docs.returns.markers.lineSuffix`	Decorative mark placed after every returns line	""
`csharp-prettier-docs.returns.markers.tag`	Decorative mark placed once before the return.	" ➥ "
`csharp-prettier-docs.returns.style.fontSize`	Font size for the returns decorator	14
`csharp-prettier-docs.returns.style.fontStyle`	Font style for return decorator	"italic"
`csharp-prettier-docs.returns.style.fontWeight`	Font weight for the returns decorator	500
`csharp-prettier-docs.summary.markers.linePrefix`	Decorative mark placed before each summary line	"═══ "
`csharp-prettier-docs.summary.markers.lineSuffix`	Decorative mark placed after each summary line	" ═══"
`csharp-prettier-docs.summary.markers.tag`	Decorative mark placed once before the summary.	""
`csharp-prettier-docs.summary.style.fontSize`	Font size for the summary decorator	15
`csharp-prettier-docs.summary.style.fontStyle`	Font style for summary decorator	"normal"
`csharp-prettier-docs.summary.style.fontWeight`	Font weight for the summary decorator	600

Marker Syntax

<blockPrefix>

Summary:
<linePrefix><tag>#Description<lineSuffix>\n
<linePrefix>#Description<lineSuffix>\n

Param:
<linePrefix><namePrefix>#name<nameSuffix><delimiter><textPrefix>#Description<lineSuffix>\n
<linePrefix>#Description<textSuffix><lineSuffix>\n

Returns:
<linePrefix><tag>Description<lineSuffix>\n
<linePrefix>Description cont.<lineSuffix>\n

Other tags:
<linePrefix>#marker-name<namePrefix?>#name?<nameSuffix?><delimiter><textPrefix?>#Description<lineSuffix>\n
<linePrefix>#Description <textSuffix?><lineSuffix>\n
<!-- Markers with ? are only applied if the tag has a name attribute -->

Colors

Name	Description
`csPrettierDoc.background`	The background color of the markers
`csPrettierDoc.summary`	Summary text color
`csPrettierDoc.param`	Param text color
`csPrettierDoc.returns`	Returns text color
`csPrettierDoc.other`	Other tags' text color

Commands

Name	Description
`csPrettierDoc.toggle`	Toggles the pretty docs

Repository

Github

License

MIT

Open-source Credits

The text decorator and configurations were based off of robertgr991/php-parameter-hint.

C# Prettier Docs

poohcom1

C# Prettier Docs

Features

Settings

Preset Example

JS Doc style

Configurations

Marker Syntax

Colors

Commands

Repository

License

Open-source Credits