microsoft / microsoft/vscode-cpptools

Full doxygen docs formatting listing each command

オープン
#7,932 コメント 1 件 リアクション 5 件 担当者 0 名 GitHub で見る

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

Feature Request Feature: Doc comments Language Service
主要言語
TypeScript
スター
6.2k
フォーク
1.7k
平均マージ
14時間 46分
マージ済み PR(30日)
61

説明

Type: Feature Request

As of now, doxygen documentation in c/cpp headers is shown when hovering methods either in short form like with fancy formatted parameter list and stuff like so:
image
or fully showing each doxygen command with no formatting at all, like this:
image

Setting C_Cpp.simplifyStructuredComments in settings.json to true (former) or false (latter) controls this behaviour

Now, it would be nice to have a way to show full documentation of a method in a formatted way, showing each doxygen command (instead of cutting text abruptly before the next doxygen command) while retaining the fancy formatting, but as a third year computer engineering undergrad that has never touched a codebase that wasn't written by themselves I found the job of implementing it myself a bit overwhelming, so if you could consider either implementing this feature or pointing me in the right direction so that I can contribute and implement and push the feature myself that would be much appreciated.

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

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

はじめの一歩

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

調査の方向性

設定 C_Cpp.simplifyStructuredComments をエントリーポイントとして使用し、C/C++ の doxygen コメントがメソッドのホバーでどのように表示されるかを追跡します。3 つ目のフォーマットモードをどのように動作させるか決める前に、既存の簡略化された動作と簡略化されていない動作を確認します。代表的な C/C++ コメントを使って検証し、既存のフォーマットされた表示を維持したまま doxygen コマンドの完全な内容が表示されれば完了です。

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

評価

技術スタック
c, cpp, typescript
領域
documentation
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

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

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