Configurable ParameterDescription Placement and Section Requirements in PSProvideCommentHelp
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
调研方向
首先定位 PSProvideCommentHelp 规则及其现有的配置处理。跟踪当前如何查找参数描述和帮助部分,然后在为 ParameterDescriptionPlacement、RequiredSections 和 RequiredSectionsOrderMatters 定义覆盖范围之前,确定该规则的测试。完成的标准是:两种放置模式和必需部分的验证(包括可选的顺序)都得到一致执行。
由索引模型根据 Issue 内容生成。
描述
Summary of the new feature
As a user of PSScriptAnalyzer, I want to be able to configure where ParameterDescription comments appear and enforce required help sections (with optional order enforcement) in the PSProvideCommentHelp rule, so that I can align documentation with my project's standards and ensure consistency.
Proposed technical implementation details (optional)
-
Configurable ParameterDescription Placement
- Add a new configuration option for PSProvideCommentHelp called
ParameterDescriptionPlacementwith two possible values:WithCommentHelp(default): Parameter descriptions are included in the comment help block as today.InParamBlock: Parameter descriptions are placed as inline comments in the param block itself.
- The setting would control where parameter docs are generated and where the rule expects to find them.
- Add a new configuration option for PSProvideCommentHelp called
-
Required Sections and Order Enforcement
- Add a configuration option called
RequiredSections, accepting an array of section names (e.g.,["Synopsis", "Description", "Parameters"]). - Add a boolean configuration option
RequiredSectionsOrderMatters(default:false). If set totrue, the order of the sections in the array is enforced in the help comment, and the rule will fail if the order is incorrect. - If
RequiredSectionsOrderMattersis false, presence of all required sections is enforced, but order is not.
- Add a configuration option called
These options would give users more flexibility in how comment-based help is structured and validated.
What is the latest version of PSScriptAnalyzer at the point of writing
2024.6.0 (or latest at time of filing)
- 主要语言
- C#
- 星标
- 2.2k
- 派生
- 422
- 平均合并
- 2 小时 23 分钟
- 30 天内合并 PR
- 25
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
PowerShell/PSScriptAnalyzer 的其他 Issue
-
Up-for-Grabs
难度 1/5 1-3 小时 新手友好度 78/100
PowerShell/PSScriptAnalyzer#2213 · 2 条评论 ·
维护者通常 1 天内回复
-
难度 4/5 1-2 天 新手友好度 18/100
PowerShell/PSScriptAnalyzer#2302 ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 55/100
PowerShell/PSScriptAnalyzer#2300 ·
维护者通常 1 天内回复
-
Invoke-ScriptAnalyzer fails intermittently with NullReferenceException in CommandInfo.ResolveParameter (ProvideCommentHelp / AvoidReservedCharInCmdlet race on Export-ModuleMember)可能已有人在做 @jessehouwing 于 89 天前认领。 未关闭Issue - Bug
难度 4/5 3-5 天 新手友好度 52/100
PowerShell/PSScriptAnalyzer#2229 · 6 条评论 ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 32/100
PowerShell/PSScriptAnalyzer#2222 · 2 条评论 ·
维护者通常 1 天内回复
查看 PowerShell/PSScriptAnalyzer 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
GamaEdtech/gamatrain-back#977 ·
维护者通常 1 天内回复
-
area-templates triage:bot-seen triage:needs-human
难度 2/5 1-3 小时 新手友好度 75/100
microsoft/aspire#22356 · 1 条评论 ·
维护者通常 1 天内回复
-
Needs-Triage
难度 2/5 1-3 小时 新手友好度 84/100
PowerShell/PowerShell#28432 · 1 条评论 · 1 个 reaction ·
维护者通常 1 天内回复
-
documentation
难度 2/5 1-3 小时 新手友好度 78/100
microsoft/aspire.dev#2184 ·
维护者通常 2 天内回复
-
area-controls-refreshview platform/ios s/triaged
难度 2/5 1-3 小时 新手友好度 74/100
dotnet/maui#40314 · 1 个 reaction ·
维护者通常 1 天内回复