XmlDoc2CmdletDoc | Create cmdlet XML help files from XML doc comments

by red-gate C# Version: 0.2.2 License: Non-SPDX

X-Ray Key Features Code Snippets(3)Community Discussions(1)Vulnerabilities Install Support

kandi X-RAY | XmlDoc2CmdletDoc Summary

XmlDoc2CmdletDoc is a C# library typically used in Utilities applications. XmlDoc2CmdletDoc has no bugs, it has no vulnerabilities and it has low support. However XmlDoc2CmdletDoc has a Non-SPDX License. You can download it from GitHub.

The description for a cmdlet parameter is defined using elements in the XML doc comment for the parameter's field or property. Tag the elements with a type="description" attribute. For guidance on writing the parameter description, see

Support

Quality

Security

License

Reuse

Support

XmlDoc2CmdletDoc has a low active ecosystem.

It has 57 star(s) with 21 fork(s). There are 60 watchers for this library.

It had no major release in the last 12 months.

There are 14 open issues and 18 have been closed. On average issues are closed in 133 days. There are 1 open pull requests and 0 closed requests.

It has a neutral sentiment in the developer community.

The latest version of XmlDoc2CmdletDoc is 0.2.2

Quality

XmlDoc2CmdletDoc has 0 bugs and 0 code smells.

Security

XmlDoc2CmdletDoc has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

XmlDoc2CmdletDoc code analysis shows 0 unresolved vulnerabilities.

There are 0 security hotspots that need review.

License

XmlDoc2CmdletDoc has a Non-SPDX License.

Non-SPDX licenses can be open source with a non SPDX compliant license, or non open source licenses, and you need to review them closely before use.

Reuse

XmlDoc2CmdletDoc releases are available to install and integrate.

Installation instructions are not available. Examples and code snippets are available.

Top functions reviewed by kandi - BETA

kandi's functional review helps you automatically verify the functionalities of the libraries and avoid rework.
Currently covering the most popular Java, JavaScript and Python libraries. See a Sample of XmlDoc2CmdletDoc

Get all kandi verified functions for this library.

XmlDoc2CmdletDoc Key Features

No Key Features are available at this moment for XmlDoc2CmdletDoc.

XmlDoc2CmdletDoc Examples and Code Snippets

Examples,Notes

Lines of Code : 20

License : Non-SPDX (NOASSERTION)

Copy

/// 
///   
///     First note title
///     
///     This is the entire body text for the first note.
///     
///   
///   
///     Second note title
///     
///       The first paragraph of the body text for the second note.
///       The second

Examples,Type description

Lines of Code : 17

License : Non-SPDX (NOASSERTION)

Copy

[Cmdlet("Test", "MyExample")]
public class TestMyExampleCommand : Cmdlet
{
    [Parameter]
    public MyType MyParameter {get; set;}
    
    ...
}

/// 
/// This is part of the type description.
/// This is also part of the type description.
/// 
pu

Examples,Parameter description

Lines of Code : 13

License : Non-SPDX (NOASSERTION)

Copy

[Cmdlet("Test", "MyExample")]
public class TestMyExampleCommand : Cmdlet
{
    /// 
    /// This is part of the parameter description.
    /// This is also part of the parameter description.
    /// 
    [Parameter]
    public string MyParameter {get

Community Discussions

Trending Discussions on XmlDoc2CmdletDoc

How to document C# Cmdlet

QUESTION

How to document C# Cmdlet

Asked 2021-Jul-05 at 20:15

I looked in the ms docs but couldn't find any suggestions on how to document a Cmdlet written in C# in a way that I can get the comments in PS via Get-Help or other commands.

I found some blog posts that point to XmlDoc2CmdletDoc. I played a bit with it and it does the job but I find my code got a bit bulkier from the comments. Is this the way to go? I saw in the Az repository that they use some external markdown files. What would be the appropriate direction?

...

ANSWER

Answered 2021-Jul-05 at 20:15

(Compiled) cmdlets require external help files, which must be represented in a "noisy", complex XML-based markup format called MAML

By contrast, comment-based help is only supported in written-in-PowerShell cmdlets (a.k.a. advanced functions / scripts).

The most convenient way to author such help files is via the PlatyPS module, which allows authoring topics in Markdown format.

While compiled cmdlets can act as PowerShell modules by themselves, it is preferable to package them as directory-based modules, which is indeed required if you want to include MAML help files (*-Help.xml).

Directory-based modules also allow you to include conceptual help topics, which, however, are mere plain-text files (about_*.txt).

Note that directory-based modules composed of written-in-PowerShell cmdlets too can opt to ship their help via MAML help files (and provide conceptual help topics), but using comment-based help is more convenient.

Source https://stackoverflow.com/questions/68261145

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install XmlDoc2CmdletDoc

You can download it from GitHub.

Support

Related links are defined using <para> elements in the XML doc comment for the cmdlet class. Tag the relevant <para> elements with a type="link" attribute. The link text for each navigation link is taken from the body of the <para> element. If you want to include a uri, specify a uri attribute in the <para> element. For guidance on writing related links, see http://msdn.microsoft.com/en-us/library/bb736334.aspx.

Find more information at: