feat: Exclude comments from CRD generation but not from go struct definition

[Devaansh-Kumar]

What type of PR is this?

/kind documentation
/kind feature

What this PR does / why we need it:
This PR adds a new tag gateway:util:excludeFromCRD in CRD description which allows to exclude comments in the go struct from being included in the generated CRD, preventing unnecessary clutter in the CRD specification.

Which issue(s) this PR fixes:

Fixes #3306

Does this PR introduce a user-facing change?:

NONE

/cc @LiorLieberman @robscott

[k8s-ci-robot]

Hi @Devaansh-Kumar. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[robscott]

Thanks @Devaansh-Kumar! Do you mind adding an example of this in the PR to ensure it's working? Maybe write up a comment for #3306 (comment)?

/ok-to-test
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Devaansh-Kumar, robscott

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [robscott]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[LiorLieberman]

@Devaansh-Kumar as we discussed offline, mind also making it work for 1 line tags? like <tag> content </tag>?