HelpInfo XML 示例文件

本主题显示格式正确的可更新帮助信息文件(通常称为“HelpInfo XML 文件”)的示例。在此示例文件中,UI 区域性元素按 UI 区域性名称按字母顺序排列。 字母顺序是最佳做法,但这不是必需的。

HelpInfo XML 示例文件

<?xml version="1.0" encoding="utf-8"?>
<HelpInfo xmlns="http://schemas.microsoft.com/powershell/help/2010/05">
   <HelpContentURI>https://go.microsoft.com/fwlink/?LinkID=141553</HelpContentURI>
   <SupportedUICultures>
    <UICulture>
      <UICultureName>de-DE</UICultureName>
      <UICultureVersion>2.15.0.10</UICultureVersion>
    </UICulture>
    <UICulture>
      <UICultureName>en-US</UICultureName>
      <UICultureVersion>3.2.0.7</UICultureVersion>
    </UICulture>
    <UICulture>
      <UICultureName>it-IT</UICultureName>
      <UICultureVersion>1.1.0.5</UICultureVersion>
    </UICulture>
    <UICulture>
      <UICultureName>ja-JP</UICultureName>
      <UICultureVersion>3.2.0.4</UICultureVersion>
    </UICulture>
   </SupportedUICultures>
</HelpInfo>

注释

基于 XML 的帮助的手动创作非常困难。 PlatyPS 模块允许你在 Markdown 中编写帮助,然后将其转换为基于 XML 的帮助。 这使得编写和维护帮助变得更加容易。 PlatyPS 也可以为你创建可更新的帮助包。 有关详细信息,请参阅 使用 PlatyPS创建基于 XML 的帮助。