Skip to content

Commit 3a43887

Browse files
committed
Updated advice on how to use XmlDoc2CmdletDoc.
1 parent 9c698e8 commit 3a43887

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,20 @@ It's easy to write good help documentation for PowerShell *script* modules (thos
44

55
For more details, [Michael Sorens](https://www.simple-talk.com/author/michael-sorens/) has written a [comprehensive guide to documenting your PowerShell binary cmdlets](https://www.simple-talk.com/dotnet/software-tools/documenting-your-powershell-binary-cmdlets/) using XmlDoc2CmdletDoc.
66

7-
To create a .dll-Help.xml file for your binary PowerShell module, simply call:
7+
To create a .dll-Help.xml file for your binary PowerShell module:
88

9-
```batchfile
10-
XmlDoc2CmdletDoc.exe C:\Full\Path\To\MyPowerShellModule.dll
9+
1. Ensure that your project is configured to generate an XML Documentation file alongside its output assembly.
10+
2. Install the XmlDoc2CmdletDoc NuGet package into your project.
11+
12+
Optionally, you can enable strict mode to cause a build error if any of your cmdlets are missing required documentation elements. To do so, add the following property to an appropriate `PropertyGroup` element in your project file:
13+
14+
```xml
15+
<XmlDoc2CmdletDocStrict>true</XmlDoc2CmdletDocStrict>
1116
```
1217

18+
19+
# Examples
20+
1321
Here are some examples of how to document your cmdlets:
1422

1523

0 commit comments

Comments
 (0)