phpDocumentor / phpDocumentor/ReflectionDocBlock

Support Annotation-style tags

オープン
#199 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
PHP
スター
9.4k
フォーク
137
平均マージ
4日 2時間
マージ済み PR(30日)
1

説明

Tags like @Route("/anonymization_preset", name="anonymization_preset_") show the part between parenthesis as part of the description. It would be more convenient to make this a first-class citizen as now this conflicts with the rule that descriptions may be parsed as Markdown documents.

See https://github.com/phpDocumentor/phpDocumentor/issues/2081 for more information

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まずこの issue とリンクされた phpDocumentor issue 2081 を読み、意図された Annotation-style tag 構文と、それが Markdown の説明とどのように異なるべきかを明確にします。次に、ReflectionDocBlock における tag の解析と説明の処理のエントリーポイントを特定します。example annotation が説明の一部として解析されず、first-class tag として扱われ、新しい動作がカバレッジでカバーされていれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
php
領域
documentation
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。