DDC-1198: Add PHPDocs to annotationclasses #1508

Closed
opened 2026-01-22 13:16:28 +01:00 by admin · 1 comment
Owner

Originally created by @doctrinebot on GitHub (Jun 8, 2011).

Originally assigned to: @Ocramius on GitHub.

Jira issue originally created by user pulse00:

If an IDE would like to support annotations, it's currently only possible to display all resolvable classes in a code-hint menu when autocompleting annotations, as
basically any class can be used for annotations.

To make it possible for IDEs to detect classes which are explicitly meant to be used as annotations, it would be nice to agree on some common
way of documenting annotations in PHPDocBlocks.

Here's an example of what this could look like:

25a14e9edc

This way IDEs can prioritize annotated classes in code-hints and add additional information to the user.

Originally created by @doctrinebot on GitHub (Jun 8, 2011). Originally assigned to: @Ocramius on GitHub. Jira issue originally created by user pulse00: If an IDE would like to support annotations, it's currently only possible to display all resolvable classes in a code-hint menu when autocompleting annotations, as basically any class can be used for annotations. To make it possible for IDEs to detect classes which are explicitly meant to be used as annotations, it would be nice to agree on some common way of documenting annotations in PHPDocBlocks. Here's an example of what this could look like: https://github.com/pulse00/doctrine2/commit/25a14e9edc406edfd33e54fc38922a191e9cbe83 This way IDEs can prioritize annotated classes in code-hints and add additional information to the user.
admin added the ImprovementInvalid labels 2026-01-22 13:16:28 +01:00
admin closed this issue 2026-01-22 13:16:30 +01:00
Author
Owner

@malukenho commented on GitHub (Jan 3, 2017):

@Ocramius @lcobucci It's not related to the ORM IMHO

@malukenho commented on GitHub (Jan 3, 2017): @Ocramius @lcobucci It's not related to the ORM IMHO
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: doctrine/archived-orm#1508