René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Configurable ParameterDescription Placement and Section Requirements in PSProvideCommentHelp","articleBody":"**Summary of the new feature**\n\nAs 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.\n\n**Proposed technical implementation details (optional)**\n\n1. **Configurable ParameterDescription Placement**\n    - Add a new configuration option for PSProvideCommentHelp called `ParameterDescriptionPlacement` with two possible values:\n        - `WithCommentHelp` (default): Parameter descriptions are included in the comment help block as today.\n        - `InParamBlock`: Parameter descriptions are placed as inline comments in the param block itself.\n    - The setting would control where parameter docs are generated and where the rule expects to find them.\n\n2. **Required Sections and Order Enforcement**\n    - Add a configuration option called `RequiredSections`, accepting an array of section names (e.g., `[\"Synopsis\", \"Description\", \"Parameters\"]`).\n    - Add a boolean configuration option `RequiredSectionsOrderMatters` (default: `false`). If set to `true`, the order of the sections in the array is enforced in the help comment, and the rule will fail if the order is incorrect.\n    - If `RequiredSectionsOrderMatters` is false, presence of all required sections is enforced, but order is not.\n\nThese options would give users more flexibility in how comment-based help is structured and validated.\n\n**What is the latest version of PSScriptAnalyzer at the point of writing**\n\n2024.6.0 (or latest at time of filing)\n","author":{"url":"https://github.com/MariusStorhaug","@type":"Person","name":"MariusStorhaug"},"datePublished":"2025-10-12T21:06:17.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/2133/PSScriptAnalyzer/issues/2133"}