docs: Convert Doctrine annotations to PHP attributes #318
Conversation
Update code examples in documentation to use PHP 8 attribute syntax instead of Doctrine annotation syntax: Japanese documentation: - form.md: @formvalidation, @inputvalidation, @VndError, @Inject, @nAmed - content-negotiation.md: @produces - js-ui.md: @ssr - html-twig-v2.md: @embed, @nAmed - database.dbal.md: @Inject, @nAmed - databasev1.md: @ReadOnlyConnection, @WriteConnection, @transactional, @Inject, @nAmed English documentation: - form.md: @formvalidation, @inputvalidation, @VndError, @Inject, @nAmed - content-negotiation.md: @produces - js-ui.md: @ssr - html-twig-v2.md: @embed, @nAmed - database.dbal.md: @Inject, @nAmed - databasev1.md: @ReadOnlyConnection, @WriteConnection, @transactional, @Inject, @nAmed - validation.md: @Valid, @OnValidate, @OnFailure - coding-guide.md: @Cacheable, @embed, @link, @transactional, @assisted
Walkthrough複数のマニュアルファイルを更新して、PHPDocスタイルのアノテーション（ Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Possibly related PRs
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
manuals/1.0/en/validation.md (1)
209-209: 冗長な表現を削除することを検討してください。Line 209の"First of all"という表現は冗長です。より簡潔な表現に置き換えることをお勧めします。
提案
- First of all, annotate the method that you want to validate with `#[Valid]` + Annotate the method that you want to validate with `#[Valid]`manuals/1.0/en/coding-guide.md (1)
161-161: タイプミスを修正してください。「"core concers" will work」の「concers」は「concerns」が正しいです。
提案
- but "core concers" will work without issue.) + but "core concerns" will work without issue.)
📜 Review details
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (14)
manuals/1.0/en/coding-guide.md(3 hunks)manuals/1.0/en/content-negotiation.md(2 hunks)manuals/1.0/en/database.dbal.md(1 hunks)manuals/1.0/en/databasev1.md(5 hunks)manuals/1.0/en/form.md(6 hunks)manuals/1.0/en/html-twig-v2.md(2 hunks)manuals/1.0/en/js-ui.md(3 hunks)manuals/1.0/en/validation.md(7 hunks)manuals/1.0/ja/content-negotiation.md(2 hunks)manuals/1.0/ja/database.dbal.md(1 hunks)manuals/1.0/ja/databasev1.md(4 hunks)manuals/1.0/ja/form.md(6 hunks)manuals/1.0/ja/html-twig-v2.md(2 hunks)manuals/1.0/ja/js-ui.md(3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
manuals/1.0/{en,ja}/*.md
📄 CodeRabbit inference engine (CLAUDE.md)
All documentation markdown files should be placed in 'manuals/1.0/{en,ja}/' directories.
Files:
manuals/1.0/en/validation.mdmanuals/1.0/en/content-negotiation.mdmanuals/1.0/en/databasev1.mdmanuals/1.0/ja/content-negotiation.mdmanuals/1.0/en/js-ui.mdmanuals/1.0/ja/databasev1.mdmanuals/1.0/en/database.dbal.mdmanuals/1.0/ja/js-ui.mdmanuals/1.0/en/html-twig-v2.mdmanuals/1.0/ja/database.dbal.mdmanuals/1.0/ja/html-twig-v2.mdmanuals/1.0/en/coding-guide.mdmanuals/1.0/ja/form.mdmanuals/1.0/en/form.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: koriym
Repo: bearsunday/bearsunday.github.io PR: 296
File: manuals/1.0/en/325.cli.md:265-265
Timestamp: 2024-11-14T20:35:37.197Z
Learning: ドキュメントの例では、未リリースのPHPバージョン（`php8.4`など）を使用しても問題ありません。これはあくまで例示のためです。
🪛 LanguageTool
manuals/1.0/en/validation.md
[style] ~209-~209: Often, this adverbial phrase is redundant. Consider using an alternative.
Context: ...date], #[OnFailure]` for validation. First of all, annotate the method that you want to v...
(FIRST_OF_ALL)
manuals/1.0/en/coding-guide.md
[grammar] ~161-~161: Ensure spelling is correct
Context: ... of transaction will be lost, but "core concers" will work without issue.) * Prevent th...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
manuals/1.0/ja/form.md
[uncategorized] ~178-~178: 「ことができる」という表現は冗長な可能性があります。
Context: ...ように例外を投げるようになります。作成したPageリソースをAPIとして使用することができます： ```php use BEAR\Package\AbstractApp...
(DOUSI_KOTOGADEKIRU)
manuals/1.0/en/form.md
[style] ~73-~73: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... Attribute Annotate the method that we want to validate with the #[FormValidation], ...
(REP_WANT_TO_VB)
🪛 markdownlint-cli2 (0.18.1)
manuals/1.0/en/validation.md
11-11: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
manuals/1.0/en/coding-guide.md
161-161: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
162-162: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
🔇 Additional comments (25)
manuals/1.0/ja/content-negotiation.md (1)
70-70: 変換内容が正確です。
@Producesアノテーションから#[Produces]アトリビュートへの変換が適切に行われています。配列構文も正しくPHP 8属性形式に対応しています。Also applies to: 83-83, 88-88
manuals/1.0/en/validation.md (1)
11-11: 属性変換が正確です。
@Valid、@OnValidate、@OnFailureアノテーションからPHP 8属性への変換が一貫して行われており、構文も正しいです。Also applies to: 175-291
manuals/1.0/ja/database.dbal.md (1)
60-66: DI属性の変換が正確です。
@Injectと@NamedアノテーションからPHP 8属性への変換が適切に行われています。use文の追加とメソッド宣言前の属性スタッキングが正しく実装されています。manuals/1.0/en/js-ui.md (1)
164-164: SSR属性の変換が正確です。
@SsrアノテーションからPHP 8属性への変換が適切に行われています。単一属性と複数の名前付きパラメータを持つ属性両方の構文が正しく実装されています。Also applies to: 166-166, 178-178, 193-197
manuals/1.0/en/content-negotiation.md (1)
70-70: 属性への変換が正確です。
@Producesアノテーションから#[Produces]属性への変換が適切に行われており、配列構文もPHP 8形式に正しく対応しています。Also applies to: 83-83, 88-88
manuals/1.0/en/database.dbal.md (1)
59-65: DI属性への変換が正確です。
@Injectと@NamedからPHP 8属性への変換が適切に行われています。use文の追加と属性のスタッキングが正しく実装されています。manuals/1.0/ja/databasev1.md (1)
240-240: 属性変換が包括的かつ正確です。複数のアノテーション（
@ReadOnlyConnection、@WriteConnection、@Named、@Inject、@Transactional）からPHP 8属性への変換が一貫して行われています。用語「アトリビュート」への統一、use文の追加、配列構文の正確な更新が確認できます。Also applies to: 248-248, 255-255, 261-261, 272-272, 275-284, 302-302, 308-308, 315-322
manuals/1.0/en/coding-guide.md (1)
40-40: 属性への変換が正確です。クラスレベルおよびメソッドレベルの属性、複数の属性のスタッキング、名前付きパラメータの構文がすべて正しく実装されています。
Also applies to: 46-46, 54-55, 161-162
manuals/1.0/en/databasev1.md (3)
127-154: 属性構文への変換が正しく実施されています。#[ReadOnlyConnection]と#[WriteConnection]属性への変換が適切に行われており、インポート文も対応する注釈クラスを参照しています。ドキュメント内の説明文も属性の使用法を正確に反映しています。
158-170: #[Named]属性と#[Inject]属性の実装が適切です。属性構文が正しく実装されています。#[Named('log_db')]の引数指定も適切なコロン区切り形式に統一されています。
195-214: #[Transactional]属性の配列構文が正しく変換されています。アノテーション形式の
{"pdo", "userDb"}からPHP属性形式の['pdo', 'userDb']への変換が適切に実施されており、デフォルト値の説明も明確です。manuals/1.0/ja/js-ui.md (2)
159-181: #[Ssr]属性への変換が適切に実装されています。属性構文が正しく、パラメータ指定も適切なコロン区切り形式に統一されています。ドキュメントのセクションタイトルも「#[Ssr]アトリビュート」に適切に更新されています。
188-202: 複数パラメータを持つ#[Ssr]属性の記述が正確です。複数行にわたる属性定義で、
stateとmetasのパラメータが適切なPHP配列構文（角括弧）で記述されており、可読性も良好です。manuals/1.0/en/form.md (4)
39-79: #[FormValidation]属性への変換と型指定の改善が適切です。属性構文への変換が正しく実施され、
protected FormInterface $form;として型ヒントが追加されており、コード品質が向上しています。ドキュメントの説明文も属性の使用法を正確に記述しています。
86-106: #[Inject]と#[Named]属性の適用が正確です。メソッドシグネチャに対する属性の適用が正しく、コメントで#[FormValidation]の省略可能なパラメータについての説明も適切に提供されています。
143-176: #[InputValidation]と#[VndError]属性への変換が適切です。複数のパラメータを持つ#[VndError]属性が正しく記述され、
hrefパラメータの連想配列形式も正確なPHP構文で実装されています。
180-193: FormVndErrorModuleセクションの説明文が正確に更新されています。#[FormValidation]と#[InputValidation]属性への参照が正しく更新され、モジュール機能の説明も明確です。
manuals/1.0/ja/form.md (4)
38-79: 日本語版のFormValidation属性への変換が正確です。「アトリビュート」用語が一貫して使用されており、属性の説明文も正確に翻訳・適応されています。型指定されたプロパティの実装も英語版と一致しています。
86-108: InjectおよびNamed属性の日本語実装が正確です。属性構文が正しく、日本語の説明文も適切に更新されており、パラメータの説明も明確です。
141-174: InputValidationおよびVndError属性の日本語版が正確です。属性構文が正しく、複数パラメータを持つVndError属性の記述も適切です。日本語の説明文も属性の動作を正確に説明しています。
178-192: FormVndErrorModuleセクションの日本語版が適切に更新されています。#[FormValidation]と#[InputValidation]属性への参照が正確であり、モジュール機能の説明も明確です。
manuals/1.0/ja/html-twig-v2.md (2)
174-184: #[Embed]属性への変換が正確です。属性構文が正しく、必要なインポート文も追加されています。パラメータ指定も適切なコロン区切り形式に統一されています。
202-219: 型指定と#[Named]属性の実装が適切です。プロパティとメソッドの戻り値の型指定が追加され、コード品質が向上しています。#[Named('original')]属性の適用も正確です。
manuals/1.0/en/html-twig-v2.md (2)
187-197: #[Embed]属性への変換が正確です（英語版）。属性構文が正しく、インポート文も適切に追加されています。パラメータ指定もコロン区切り形式で統一されています。
216-232: 型指定と#[Named]属性の実装が適切です（英語版）。プロパティと戻り値の型指定が追加されており、#[Named('original')]属性も正確に適用されています。日本語版と一貫しています。
Update code examples in documentation to use PHP 8 attribute syntax
instead of Doctrine annotation syntax:
Japanese documentation:
English documentation:
Summary by CodeRabbit
リリースノート
✏️ Tip: You can customize this high-level summary in your review settings.