如何用PHPDoc记录数组键/值的含义？

如何解决如何用PHPDoc记录数组键/值的含义？

我有一个数组，表示字符串之间的某些映射。密钥和值都具有（业务）含义。例如，在数组中：

[
    '10000' => 'f4970340-9cb7-4380-948c-54e0d1556d58','20000' => '665cdd7d-dbef-4c0a-963e-467a68fa097f','84000' => '5b7f0abc-a515-4409-8b70-f1aafeef5038',… # more entries
]

10000，20000和84000代表客户。 UUID代表客户所属的组。

关于如何记录字符串的含义，是否有惯例/最佳实践？我不是在讨论记录类型（= strings）。

类似的东西：

    /**
     * @return string[]
     * [
     *     customerId => groupId,*     …
     * ]
     */
    public function getCustomerIdGroupIdMap(): array
    {}

解决方法

在我见过和使用过的所有情况下，text description都是添加特定注释以阐明细节的最佳位置。

<?php

/**
 * Returns an array keyed by the customer ID. The values represent the group ID. 
 * @return array
 */
public function getCustomerIdGroupIdMap(): array
{}

或者，可以使用description of the return type。

<?php

/**
 * @return array Keyed by the customer ID. The values represent the group ID. 
 */
public function getCustomerIdGroupIdMap(): array
{}