• Packages
  • Themes
  • Documentation
  • Blog
  • Discussions
Sign in

xmldoc-snippets

Atom XML-Doc snippets intended for C#
  • #c#
  • #snippets
  • #xml
  • #doc
  • #visual
Mohammed-El-Nabulsi
1.0.1 581
0
  • Repo
  • Bugs
  • Versions
  • License
Flag as spam or malicious

xmldoc-snippets

Atom XML-Doc snippets intended for C#.

References

XML Doc documentation: https://msdn.microsoft.com/de-de/library/b2s063f7(v=vs.71).aspx
XML Doc examples: https://msdn.microsoft.com/en-us/library/b2s063f7(v=VS.100).aspx

Remarks

This does not support lists and includes.

Usage

snippet
-----------------------------------------
result

Modular snippets

///s
-----------------------------------------
/// <summary>
/// ${1:General description}
/// </summary>$2
///re
-----------------------------------------
/// <remarks>
/// ${1:Detailed remarks}
/// </remarks>$2
///r
-----------------------------------------
/// <returns>
/// ${1:Return value description}
/// </returns>$2
///pa
-----------------------------------------
/// <param name="${1:Param name}">${2:Param description}</param>$3
///ex
-----------------------------------------
/// <exception cref="${1:Exception type}">Thrown when ${2:condition}</exception>$3
///sea
-----------------------------------------
/// <seealso cref="${1:Ref name}">
/// ${2:Ref description}
/// </seealso>$3
///e
-----------------------------------------
/// <example>
/// ${1:Example description}
/// <code>
/// ${2:Code}
/// </code>
/// </example>$3

Inline snippets

see
-----------------------------------------
<see cref="${1:Ref name}"/>$2
paramref
-----------------------------------------
<paramref name="${1:Ref name}"/>$2
para
-----------------------------------------
<para>${1:Content}</para>$2
permission
-----------------------------------------
<permission cref="${1:Permission type}">${2:Description}</permission>$3

Semantic snippets

///a            // For use on an action
-----------------------------------------
/// <summary>
/// ${1:Action description}
/// </summary>
/// <param name="${2:Param name}">${3:Param description}</param>$4
///f            // For use on a function
-----------------------------------------
/// <summary>
/// ${1:Function description}
/// </summary>
/// <param name="${2:Param name}">${3:Param description}</param>
/// <returns>
/// ${4:Return value description}
/// </returns>$5
///p             // For use on properties
-----------------------------------------
/// <summary>
/// ${1:Property description}
/// </summary>
/// <value>
/// ${2:Property value}
/// </value>$3

I think this package is bad news.

Good catch. Let us know what about this package looks wrong to you, and we'll investigate right away.

  • Terms of Use
  • Privacy
  • Code of Conduct
  • Releases
  • FAQ
  • Contact
with by