個人用のローカルコメント(lcコメント)を作成できます。
ソースコード自体は一切書き換えず、ワークスペース直下の隠しフォルダ .lc/ 内に JSON として保存されるため、Git の差分(git status / git diff)を汚さずに複数行のメモや調査記録を残すことができます。
使い方
① lcコメントを追加する
- エディタ上でコメントを付けたい行にカーソルを合わせます。
- 右クリック > 「lcコメント追加」 を選択します。
- 画面横に一時 Markdown エディタ(
[lcコメント新規] ファイル名 (N行目).md)が開きます。
- コメントを入力(複数行・Markdown 記法対応)し、以下のいずれかで保存します:
- キーボードの
Ctrl + S を押す
- エディタ上部の
💾 保存して完了 (Ctrl+S) をクリックする
- タブ右上の
✓(チェック)アイコン をクリックする
- 保存すると一時タブが自動的に閉じ、対象行の直上に lcコメントが表示されます。
- ※保存せずにやめる場合は、上部の
✖ キャンセルして閉じる またはタブ右上の × を押してください。
② lcコメントを読む(複数行表示)
- 1行プレビュー: 対象行の直上に CodeLens として1行目(複数行ある場合は
(+他N行) 付き)が常時表示されます。
- 複数行ポップアップ:
- 対象のコード行にマウスカーソルを合わせる(ホバーする)、または CodeLens の
💬 ... をクリックすると、複数行のコメント全文が Markdown 形式でポップアップ表示されます。
③ lcコメントを編集・削除する
- 編集:
- 行上の CodeLens にある
✏️ 編集、またはホバーポップアップ内の [✏️ 編集] をクリックすると、現在の本文が入った一時エディタが開きます。修正して Ctrl + S を押すと更新されます。
- 削除:
- 行上の CodeLens にある
🗑️ 削除、またはホバーポップアップ内の [🗑️ 削除] をクリックします。
- 誤操作防止のため確認ポップアップ(先頭最大5行のプレビュー付き)が表示され、「削除する」 を押すと削除されます。
- ファイル内のコメントが 0 件になると、対応する
.lc/<hash>.json ファイルも自動的に削除されます。
④ 下部パネル「lcコメント」一覧からジャンプする
- VS Code 下部パネル(ターミナルや出力が並ぶ領域)にある 「lcコメント」タブ を開くと、ワークスペース内の全ファイルの lcコメントが一覧表示されます。
- 表示形式:
[クラス名.メソッド名:N行目] コメント1行目(ファイル相対パス付き)
- 項目をクリックすると、該当ファイルの対象行が開き、画面中央(
InCenter)にフォーカスされます。
- パネル上には誤削除防止のため削除ボタンは設けていません(右上には 「再読み込み」 ボタンのみ配置しています)。
⑤ 行やメソッドが消えて「孤立」したコメントを再紐付けする
git pull 等で対象行やメソッドが削除・書き換えられた場合、そのコメントは消えずにメソッド先頭・クラス先頭(またはファイル先頭)に以下の CodeLens として表示されます:
⚠️ [lcコメント] 元の行またはメソッドが変更されました (N件) — クリックして確認・再紐付け
クリックすると選択メニュー(QuickPick)が開き、元のコードを確認した上で以下の3つから操作を選べます:
- 現在のカーソル行に再紐付けして復元: いまカーソルがある行へコメントを付け直します。
- この位置(メソッド/クラス先頭)に復元: 基準行に通常の lcコメントとして復活させます。
- このlcコメントを削除: 不要になったコメントを削除します。
⑥ バックアップと復元
- ワークスペース直下の
.lc フォルダをそのままコピーしておくだけでバックアップになります。別環境やクローンし直したリポジトリに .lc フォルダを配置すれば、即座にすべてのコメントが復元されます。
| |