[AVM CI Environment Issue]: Update the ReadME Generation so that comments are carried from the test files into the readme

### Check for previous/existing GitHub issues

- [x] I have checked for previous/existing GitHub issues

### Issue Type?

Feature Request

### Description

Example: [ref](https://github.com/Azure/bicep-registry-modules/pull/6335/commits/0643080b1ae5717ff287f5b07157648988ebd961)

We could get started with inline comments and retrospectively match comments from the test file to the inline parameter name in the usage examples.
For full-on comment blocks on top of parameters it would be more complicated as we'd need to match it with whatever next parameter name below it. This has the additional complication that contributors may have used the comment to e.g., group a section of the test file which won't carry over into the sorted param block in the readme.

PS: The parameters are sorted so that the result is deteministic. Without, different systems may convert the parameter block to differntly-sorted JSON blocks and hence fail the static tests. It may be possible to ignore this if we don't use JSON as the basis anymore (i.e., fully depend on interpreting Bicep). E.g. either by only using the JSON for the JSON-parameter example, or removing it entirely.