Description

Attributes are used in application codebase to configure specific behaviors. It's sometimes difficult, especially for a novice, to understand the purpose of an attribute or one of its parameters. To improve the developer experience, I suggest adding a description for each attribute class and parameter. Even if it seems obvious, it's a good idea to be explicit.

If you want to work on a class, or a set of classes, please comment this issue before to avoid duplicate work by someone else.

List of all attributes classes to track the progress (checked = doc is complete):

Can be ignored -> deprecated

• Symfony\Component\DependencyInjection\Attribute\MapDecorated

Can be ignored -> already good 👍

• Symfony\Component\DependencyInjection\Attribute\Exclude

Todo

• Symfony\Component\Validator\Constraints\GroupSequenceProvider

In progress

• Symfony\Component\Validator\Constraints\GroupSequence [Validator] Add PHPDoc to GroupSequence attribute class and properties #53428
• Symfony\Bundle\FrameworkBundle\Routing\Attribute/AsRoutingConditionService [FrameworkBundle][RemoteEvent][Routing][Scheduler] Add PHPDoc to attributes properties #51996
• Symfony\Component\RemoteEvent\Attribute\AsRemoteEventConsumer [FrameworkBundle][RemoteEvent][Routing][Scheduler] Add PHPDoc to attributes properties #51996
• Symfony\Component\Routing\Annotation\Route [FrameworkBundle][RemoteEvent][Routing][Scheduler] Add PHPDoc to attributes properties #51996
• Symfony\Component\Scheduler\Attribute\AsCronTask[FrameworkBundle][RemoteEvent][Routing][Scheduler] Add PHPDoc to attributes properties #51996
• Symfony\Component\Scheduler\Attribute\AsPeriodicTask [FrameworkBundle][RemoteEvent][Routing][Scheduler] Add PHPDoc to attributes properties #51996
• Symfony\Component\Scheduler\Attribute\AsSchedule [FrameworkBundle][RemoteEvent][Routing][Scheduler] Add PHPDoc to attributes properties #51996

Already done

• Symfony\Component\Validator\Constraints\Isbn [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Bridge\Doctrine\Attribute\MapEntity [DoctrineBridge][TwigBridge] Add PHPDoc to attributes #51987
• Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity [DoctrineBridge][TwigBridge] Add PHPDoc to attributes #51987
• Symfony\Bridge\Twig\Attribute\Template [DoctrineBridge][TwigBridge] Add PHPDoc to attributes #51987
• Symfony\Component\Console\Attribute\AsCommand [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974
• Symfony\Component\DependencyInjection\Attribute\AsAlias [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\DependencyInjection\Attribute\AsDecorator [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\DependencyInjection\Attribute\AsTaggedItem [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\DependencyInjection\Attribute\Autoconfigure [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\DependencyInjection\Attribute\AutoconfigureTag [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\DependencyInjection\Attribute\Autowire
• Symfony\Component\DependencyInjection\Attribute\AutowireCallable [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\DependencyInjection\Attribute\AutowireDecorated [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\DependencyInjection\Attribute\AutowireIterator [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\DependencyInjection\Attribute\AutowireLocator [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\DependencyInjection\Attribute\AutowireServiceClosure [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\DependencyInjection\Attribute\TaggedIterator [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\DependencyInjection\Attribute\TaggedLocator [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\DependencyInjection\Attribute\Target [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\DependencyInjection\Attribute\When [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\EventDispatcher\Attribute\AsEventListener [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974
• Symfony\Component\HttpKernel\Attribute\AsController [HttpKernel] Improve PHPDoc on #[AsController] attribute #52147
• Symfony\Component\HttpKernel\Attribute\AsTargetedValueResolver [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\HttpKernel\Attribute\Cache [HttpFoundation]  Improve PHPDoc of Cache attribute #51968
• Symfony\Component\HttpKernel\Attribute\MapDateTime [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\HttpKernel\Attribute\MapQueryParameter [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\HttpKernel\Attribute\MapQueryString [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\HttpKernel\Attribute\MapRequestPayload [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\HttpKernel\Attribute\ValueResolver [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\HttpKernel\Attribute\WithHttpStatus [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\HttpKernel\Attribute\WithLogLevel [DependencyInjection][HttpKernel] Add PHPDoc to attribute classes and properties #51971
• Symfony\Component\Messenger\Attribute\AsMessageHandler [Messenger] Improve PHPDoc descriptions of attribute classes and properties #52475
• Symfony\Component\Security\Core\Validator/Constraints/UserPassword [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974
• Symfony\Component\Security\Http\Attribute/CurrentUser [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974
• Symfony\Component\Security\Http\Attribute/IsGranted [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974
• Symfony\Component\Serializer\Annotation\Context [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974
• Symfony\Component\Serializer\Annotation\DiscriminatorMap [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974
• Symfony\Component\Serializer\Annotation\Groups [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974
• Symfony\Component\Serializer\Annotation\Ignore [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974
• Symfony\Component\Serializer\Annotation\MaxDepth [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974
• Symfony\Component\Serializer\Annotation\SerializedName [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974
• Symfony\Component\Serializer\Annotation\SerializedPath [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974
• Symfony\Component\Validator\Attribute\HasNamedArguments [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\All [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\AtLeastOneOf [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Bic [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Blank [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Callback [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\CardScheme [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Cascade [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Choice [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Cidr [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Collection [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Count [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Country [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\CssColor [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Currency [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Date [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\DateTime [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\DisableAutoMapping [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\DivisibleBy [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Email [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\EnableAutoMapping [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\EqualTo [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Expression [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\ExpressionLanguageSyntax [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\ExpressionSyntax [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\File [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\GreaterThan [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\GreaterThanOrEqual [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Hostname [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Iban [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\IdenticalTo [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Image [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Ip [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\IsFalse [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Isin [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\IsNull [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Issn [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\IsTrue [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Json [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Language [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Length [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\LessThan [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\LessThanOrEqual [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Locale [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Luhn [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Negative [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\NegativeOrZero [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\NoSuspiciousCharacters [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\NotBlank [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\NotCompromisedPassword [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\NotEqualTo [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\NotIdenticalTo [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\NotNull [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\PasswordStrength [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Positive [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\PositiveOrZero [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Range [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Regex [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Sequentially [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Time [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Timezone [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Traverse [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Type [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Ulid [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Unique [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Url [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Uuid [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\Valid [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Validator\Constraints\When [Validator] Add PHPDoc to validator constraints #52012
• Symfony\Component\Workflow\Attribute\AsAnnounceListener [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974
• Symfony\Component\Workflow\Attribute\AsCompletedListener [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974
• Symfony\Component\Workflow\Attribute\AsEnteredListener [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974
• Symfony\Component\Workflow\Attribute\AsEnterListener [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974
• Symfony\Component\Workflow\Attribute\AsGuardListener [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974
• Symfony\Component\Workflow\Attribute\AsLeaveListener [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974
• Symfony\Component\Workflow\Attribute\AsTransitionListener [Console][EventDispatcher][Security][Serializer][Workflow] Add PHPDoc to attribute classes and properties #51974

Example

The Symfony\Component\HttpKernel\Attribute\Cache class is the perfect example of what needs to be done:

• Add a description to the class header to indicate its purpose and what it does
• Add a description of each constructor argument