将帮助文件添加到模块

Question

我已经创建了一些模块，并希望添加一些README.md文件，以便为我的同事提供一些订阅或教程。

我已在右侧Directory-Folder中添加了特定的帮助文件，并使用正确的Unicode格式转换文件，如MSDN网站上的说明。

现在我给了cmd Get-Help但除了从Powershell提供的常规帮助之外什么都没有加载？

Answer 1

一种方法是直接在模块文件中编写帮助

<# 
 .Synopsis
  Whatever you want to display.

 .Description
  A description for the same.

 .Parameter Start
  Whatever Parameter start you want .

 .Parameter End
  Whatever Parameter end you want to display.

 .Example
   # Show an example below.
   Example of the function
#>

其他方式是：已列出

HERE和External Help for PS Modules

希望它有所帮助。