-
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 all commits
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
Some comments aren't visible on the classic Files Changed page.
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
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,75 @@ | ||
| # A template for an attribute definition | ||
|
|
||
| ```php | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Fig\Attributes; | ||
|
|
||
| /** | ||
| * One-Line summary of what the attribute does (PLAIN TEXT!) | ||
| * | ||
| * ## 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" | ||
| * | ||
| * ## Purpose | ||
| * | ||
| * 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. | ||
| * | ||
| * ## When should the attribute be applied? | ||
| * | ||
| * If your Attribute has preconditions for usage you MUST use the keywords | ||
Crell marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * 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 | ||
Crell marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * and keep in mind that the short description should not contain markdown. | ||
| * | ||
| * Keep your lines at a maximum of 80 Characters. It increases readability on | ||
| * smaller windows. | ||
| * | ||
| * Please also use code-snippets where appropriate | ||
| * | ||
| * ```php | ||
| * <?php | ||
| * echo 'Hello World'; | ||
| * ``` | ||
| * | ||
| * [^citation] https://en.wikipedia.org/wiki/Citation | ||
| */ | ||
| #[\Attribute(\Attribute::TARGET_CLASS)] | ||
| class Template | ||
| { | ||
| /** | ||
| * Describe your methods extensively. | ||
| * | ||
| * You also MUST describe parameters to your Attribute extensively! You | ||
| * SHOULD use the DocBlock-format as described in PSR-5 for that. | ||
| * | ||
| * @param string $name | ||
| * The name of this template. | ||
| * | ||
| * Parameter descriptions can span multiple lines. Make sure to | ||
| * separate the subject from the text by a blank line. | ||
| * @param boolean $expose | ||
| * Whether to expose this as an example or not. | ||
| * @param int[] $luckyNumbers | ||
| * The lucky numbers of this week. | ||
| */ | ||
| public function __construct( | ||
| public readonly string $name, | ||
| public readonly bool $expose, | ||
| public readonly array $luckyNumbers | ||
| ) {} | ||
| } | ||
| ``` | ||
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.
Uh oh!
There was an error while loading. Please reload this page.