Share via


CommentHelpInfo Class

Definition

The help content specified via help comments for a given script or script function.

public ref class CommentHelpInfo sealed
public sealed class CommentHelpInfo
type CommentHelpInfo = class
Public NotInheritable Class CommentHelpInfo
Inheritance
CommentHelpInfo

Constructors

CommentHelpInfo()

Properties

Component

The help content of the .COMPONENT section, if specified, otherwise null.

Description

The help content of the .DESCRIPTION section, if specified, otherwise null.

Examples

The help content from all of the specified .EXAMPLE sections.

ForwardHelpCategory

The help content of the .FORWARDHELPCATEGORY section, if specified, otherwise null.

ForwardHelpTargetName

The help content of the .FORWARDHELPTARGETNAME section, if specified, otherwise null.

Functionality

The help content of the .FUNCTIONALITY section, if specified, otherwise null.

Inputs

The help content from all of the specified .INPUT sections.

Links

The help content from all of the specified .LINK sections.

MamlHelpFile

The help content of the .MAMLHELPFILE section, if specified, otherwise null.

Notes

The help content of the .NOTES section, if specified, otherwise null.

Outputs

The help content from all of the specified .OUTPUT sections.

Parameters

The help content for each parameter where help content is specified. The key is the parameter name, the value is the help content.

RemoteHelpRunspace

The help content of the .REMOTEHELPRUNSPACE section, if specified, otherwise null.

Role

The help content of the .ROLE section, if specified, otherwise null.

Synopsis

The help content of the .SYNOPSIS section, if specified, otherwise null.

Methods

GetCommentBlock()

Returns the help info as a comment block.

Applies to