Remove comments vulnerability_details_graphql/index.vue

https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/app/assets/javascripts/security_dashboard/components/shared/vulnerability_details_graphql/index.vue

Benefits of removing comments

I would like to propose the removal of the comments in this file for the following reasons:

• Maintainability
  • The comments are derived from the documentation of GraphiQL; if those are ever changed, we need to duplicate the efforts in updating the code comments. I foresee this will be easily missed, as any GraphQL changes will be made by the BE team and they may not be aware to make the changes in the FE code. Which can lead to stale FE code and misleading comments.
  • With the additional of the code comments, we are spreading the different sources of truth, it will be more beneficial to have one single source of truth being the GraphiQL documentation.
• Readability
  • There are a lot of props in this component, including the comments significantly increases the lines of code, which can make it tedious to scroll and read through.

GraphiQL	Code

Benefits of keeping comments

I do want also to highlight some of the benefits of keeping the code:

• Quick accessibility
  • as long as the comment is kept up to date, it's very convenient to read the documentation right there and then
• Auto definition from the IDE.
  • When hovered over, you have these helpful definitions.