-
Notifications
You must be signed in to change notification settings - Fork 2
Add attribute template #3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Fig\Attributes; | ||
|
|
||
| /** | ||
| * One-Line summary of what the attribute does | ||
| * | ||
| * ## Target audience | ||
| * | ||
| * Implementors | ||
| * : Who should handle this attribute? Example: "static analysis tools" | ||
| * Users | ||
| * : Who adds this attribute to their code? Example: "packages that want to | ||
| * safeguard their functions via static analysis | ||
Crell marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| * | ||
| * Long explanation of what the attribute does and why it is relevant. | ||
| * | ||
| * Use citations[^citation] or [Links](https://example.com) in your text to make | ||
| * sure people understand the relevance and where you got your ideas from. | ||
| * | ||
| * If your Attribute has preconditions for usage you MUST use the keywords | ||
| * described in [RFC 2119](https://datatracker.ietf.org/doc/html/rfc2119). | ||
| * You SHOULD list them prominently. | ||
| * | ||
| * **Note:** DocBlock content MUST be Markdown formatted. Check out the | ||
| * [Markdown-Guide](https://www.markdownguide.org/) for possible formatting | ||
| * | ||
| * Please also use code-snippets where appropriate | ||
| * | ||
| * ```php | ||
| * <?php | ||
| * echo 'Hello World'; | ||
| * ``` | ||
| * | ||
| * You MUST describe parameters to your Attribute extensively! You SHOULD use | ||
| * the well-known Annotations for that | ||
Crell marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| * | ||
| * @param string $example_1 Does x and y | ||
| * @param boolean $example_2 | ||
Crell marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| * | ||
| * [^citation] https://en.wikipedia.org/wiki/Citation | ||
| */ | ||
| #[\Attribute(\Attribute::TARGET_CLASS)] | ||
| final class Template {} | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.