Fix incorrect `@var` docblocks

[lumnn]

Description (*)

Many of the @var docblock statements are not written in a style described by phpDocumentor which is recommended by Magento DocBlock Standard

It comes to the point where some templates have both styles of @var docblocks next to each other. https://github.com/magento/magento2/blob/2.4-develop/app/code/Magento/Catalog/view/frontend/templates/product/list.phtml#L13

Fixed Issues (if relevant)

Didn't create an issue. Is it needed?

Manual testing scenarios (*)

I don't think they're needed as changes are not in code itself, but comments

Contribution checklist (*)

• [X] Pull request has a meaningful description of its purpose
• [X] All commits are accompanied by meaningful commit messages
• [X] All new or changed code is covered with unit/integration tests (if applicable)
• [X] README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
• [X] All automated tests passed successfully (all builds are green)

[m2-assistant[bot]]

Hi @lumnn. Thank you for your contribution Here are some useful tips how you can test your changes using Magento test environment. Add the comment under your pull request to deploy test or vanilla Magento instance:

• @magento give me test instance - deploy test instance based on PR changes
• @magento give me 2.4-develop instance - deploy vanilla Magento instance

:exclamation: Automated tests can be triggered manually with an appropriate comment:

• @magento run all tests - run or re-run all required tests against the PR changes
• @magento run <test-build(s)> - run or re-run specific test build(s) For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

1. Database Compare
2. Functional Tests CE
3. Functional Tests EE,
4. Functional Tests B2B
5. Integration Tests
6. Magento Health Index
7. Sample Data Tests CE
8. Sample Data Tests EE
9. Sample Data Tests B2B
10. Static Tests
11. Unit Tests
12. WebAPI Tests
13. Semantic Version Checker

You can find more information about the builds here

:information_source: Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Magento Contributor Guide documentation.

:warning: According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

:clock10: You can find the schedule on the Magento Community Calendar page.

:telephone_receiver: The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

:pencil2: Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

[lumnn]

Additionally there is number of occurrences starting with /* instead of /**. This result in mixed behavior of syntax coloring.

They are not fixed within this PR, but I can sort it out before merging.

Example: https://github.com/magento/magento2/blob/2.4-develop/app/code/Magento/Catalog/view/adminhtml/templates/catalog/product/edit/category/new/form.phtml

Visual:

[sdzhepa]

@magento run all tests

[magento-automated-testing[bot]]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

[DeryabinSergey]

Why not merging?

[engcom-Hotel]

Hello @lumnn,

Thank you for your contribution!

There are multiple conflicts in this PR. I suggest you to break this PR into multiple PRs for e.g. module wise.

Please do the needful, meanwhile we are moving this PR on hold.

Thank you