Doxygen `@code` block not formatted if without leading spaces; when formatted includes leading `*` and has 'escape' `\`.

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

@sean-mcmanus がすでに取り組んでいます。

2026年5月9日 から。

評価

この issue はまだ評価されていません。

説明

bug Feature: Doc comments

Using C/C++ v1.32.2

Some observations of the Doxygen support for @code or \code blocks:

  /**
   * @brief Set or clear the referenced bit.
   * 
   * @param value true to set the bit, false to clear it.
   * @return Reference to this BitReference object.
   * 
   * @code
   * uint8_t flags = 0b00000000;
   * BitReference<uint8_t> bit(flags, 2);
   * bit = true;  // flags == 0b00000100
   * bit = false; // flags == 0b00000000
   * @endcode
   */

Without 4 leading spaces (this only has 2) the code block is not rendered.

Image

With 4 leading spaces it looks like this:

Image

I might have expected:

  • A Code: header to preface the code block.
  • The *'s from the Doxygen block to not be present (shown as \*).
  • the extraneous \ that appear to be trying to escape *, _, < and > (and who knows what else) to not be present in the render.
  • The last line (the * before the @endcode) to not be included in the code block.
主要言語
TypeScript
スター
6.2k
フォーク
1.7k
平均マージ
14時間 46分
マージ済み PR（30日）
61

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

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

はじめの一歩

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

microsoft/vscode-cpptools のほかの issue

microsoft/vscode-cpptools の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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