[Issue] [PHPDOC] Fix functions orderComment in Magento\Sales\Model\Order

[m2-assistant]

This issue is automatically created based on existing pull request: #39572: [PHPDOC] Fix functions orderComment in Magento\Sales\Model\Order

---

Description (*)

This PR fix the bad phpdoc in \Magento\Sales\Model\Order. The argument $comment in the following functions accept a Phrase object

• addStatusToHistory
• addStatusHistoryComment
• addCommentToStatusHistory

Here is an example where the type Phrase is used :

magento2/app/code/Magento/Paypal/Model/Ipn.php

Lines 220 to 226 in d06337a

	$message = __(
	'IPN "%1". A dispute has been resolved and closed. %2 Transaction amount %3.',
	ucfirst($reasonCode),
	$notificationAmount,
	$reasonComment
	);
	$this->_order->addStatusHistoryComment($message)->setIsCustomerNotified(false)->save();

With PHPSTAN is very complicated to setup the project with level 5 or higher :(

Related Pull Requests

None

Fixed Issues (if relevant)

None

Manual testing scenarios (*)

Setup PHPSTAN with level 5 or higher and run check.

Questions or comments

The quality of Magento code needs to be improved so that it is easier to use the code quality tools (phpstan, rector, ...) ❤️

Contribution checklist (*)

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