Closed4

VSCode で C# の XML comments がおかしくなったので対処ログ

TigRigTigRig

事象の発生に気づいた日時

2023/08/13 12:23

(2023/07/31には 発生していなかったはず……)

発生した事象

その1:XMLコメントが2重生成される

メンバ変数やメソッドなどの直上で /// (スラッシュ3つ)を入力すると、 XMLコメントが2重に生成される

その2:メンバ変数やメソッド名の行が /// でコメントアウトされる

XMLコメントがついている「メンバ変数やメソッド名」の直下に改行を入れると、「メンバ変数やメソッド名」の行が /// でコメントアウトされてしまう

TigRigTigRig

「その1:XMLコメントが2重生成される」の対処

対処法

拡張機能 C# XML Documentation Comments をアンインストールする

または拡張機能 C# のバージョンをを v1.26.0 にダウングレードする

※拡張機能ダウングレードの参考記事↓

https://dev.classmethod.jp/articles/install-previous-vscode-extension/

原因

拡張機能 C# が 2023年8月上旬に v2 系へアップデートされた模様。

ChangeLog にそれっぽい記載が見当たらなかったので確証はないが、この v2 アップデートで XML Comments がサポートされた?

⇒ 元々導入していた C# XML Documentation Comments と競合して、2重に XML Comments が生成されていたっぽい。

TigRigTigRig

「その2:メンバ変数やメソッド名の行が /// でコメントアウトされる」の対処

対処法

拡張機能 C# のバージョンをを v1.26.0 にダウングレードする

※拡張機能ダウングレードの参考記事↓

https://dev.classmethod.jp/articles/install-previous-vscode-extension/

原因

※同上

拡張機能 C# が 2023年8月上旬に v2 系へアップデートされた模様。

ChangeLog にそれっぽい記載が見当たらなかったので確証はないが、この v2 アップデートで XML Comments がサポートされた?

しかし、何やら挙動が怪しいっぽい。

GitHub の issues にも同様の事象が上がっていた。

https://github.com/dotnet/vscode-csharp/issues/6039

TigRigTigRig

結論

とりあえず 拡張機能 C# をダウングレードして様子見。

C# Dev Kit というのも出ていて、なんだか色々新しくなって便利になりそうな雰囲気ではあるが、落ち着くまでは導入しないほうがいいかも。

ただ C# Dev Kit の登場に合わせて Unity が出てきたので、出来れば早めに C# Dev Kit 使いたい……。(Debugger for Unity が非推奨になっていて困っていたので)

一旦しばらく様子見。

このスクラップは2023/08/13にクローズされました