Skip to content

Add suggested corrections for ProvideCommentHelp rule #761

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 22 commits into from
May 18, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions Engine/Settings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -416,14 +416,15 @@ private Hashtable GetHashtableFromHashTableAst(HashtableAst hashTableAst)
var strConstExprAst = constExprAst as StringConstantExpressionAst;
if (strConstExprAst != null)
{
rhsList.Add(strConstExprAst.Value);
// it is a string literal
output[key] = strConstExprAst.Value;
}
else
{
// it is either an integer or a float
output[key] = constExprAst.Value;
continue;
}
continue;
}
else if (pureExp is HashtableAst)
{
Expand Down
44 changes: 42 additions & 2 deletions RuleDocumentation/ProvideCommentHelp.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,49 @@ Comment based help should be provided for all PowerShell commands. This test onl

For assistance on comment based help, use the command ```Get-Help about_comment_based_help``` or the article, "How to Write Cmdlet Help" (http://go.microsoft.com/fwlink/?LinkID=123415).

## How
## Configuration

Include comment based help for each command identified.
```powershell
Rules = @{
PSProvideCommentHelp = @{
Enable = $true
ExportedOnly = $false
BlockComment = $true
VSCodeSnippetCorrection = $false
Placement = "before"
}
}
```

### Parameters

#### Enable: bool (Default valus is `$true`)

Enable or disable the rule during ScriptAnalyzer invocation.

#### ExportedOnly: bool (Default value is `$true`)

If enabled, throw violation only on functions/cmdlets that are exported using the 'Export-ModuleMember' cmdlet.

#### BlockComment: bool (Default value is `$true`)

If enabled, returns comment help in block comment style, i.e., `<#...#>`. Otherwise returns
comment help in line comment style, i.e., each comment line starts with `#`.

#### VSCodeSnippetCorrection: bool (Default value is `$false`)

If enabled, returns comment help in vscode snippet format.

#### Placement: string (Default value is `before`)

Represents the position of comment help with respect to the function definition.

Possible values are: `before`, `begin` and `end`. If any invalid value is given, the
property defaults to `before`.

`before` means the help is placed before the function definition.
`begin` means the help is placed at the begining of the function definition body.
`end` means the help is places the end of the function definition body.

## Example

Expand Down
Loading