Visual Stdio CodeでRestructured Textを書いているときに、TODO Treeを使いたい
| 件名 | 日付 |
|---|---|
| 記事を書いた日 | 2020-09-24 |
| 記事を変更した日 | 2025-10-17 |
上記は、この記事の鮮度を判断する一助のために書き手が載せたものです。
詳細な変更履歴は、 GitHub - yabuki/friendly-potato: zenn-contents を参照してください。
記事に対するTypoの指摘などは、pull reqをしてもらえると嬉しい。受け入れるかどうかは、差分とPull reqの文章で判断します。
はじめに
Visual Studio Code (以下、vscode)や、その派生であるVSCodium[1] を使って、Sphinx[2] のドキュメントRestructuredText[3]を扱っている人向けの記事です。
TagのRestructuredtextは、タグが切れるので抜きました。
TODO Tree とはなにか
プログラムや文書う作っている時に、下記のようにコメントに埋めて込むものです。
主にコードや文書の手が回っていないがやらないといけないことについてチケットなどにする前のメモ書きです。
メモ書きを対象のソースコードや設計文書に埋め込んで、作業を進めていくスタイルの人にはとても便利な拡張です。
-
TODO
-
FIXME
ファイル毎に、それらのマークアップを視覚化します。リンク先を見たらよりわかりやすいです。
問題点
2つあります。
- 自分の使っているタグがない。
- 残念なことにTodo Treeのデフォルト状態ではrestructured textのコメント形式には対応していない。
そのため文中に書き込まない限りTodo Treeはタグを検知しません。
そのために次の施策をする。
Todo Treeをrestructued textに対応させる
Tagの追加
"ユーザー設定->設定" で設定画面をだして、拡張機能から、Todo Treeaを選択して、下記のような画面を出します。
ここに書いてあるタグでたりないなら、チームで、共有するならワークスペース経由で、個人ならそのまま設定に書きます。
例えば、人によっては NOTE Tagが足りてない人もいるでしょう。ただし、sphinxの記法で注釈を表す下記の
記法があります。
.. note::
注意深くUpper Lowerを管理できる人でないなら、Restructured textというか、sphinxの時には気をつけた方が良いです。
Restructured textのコメントになる条件は、みなさん一度はハマるので、確認したほうがいいとおもいますが、
簡単に言うと .. (dot)2つでコメントです。
restructued textもpythonと同じく、インデントが重要なのです。
コメントにしてもTagを認識させる
Regex: Regex
Regular expression for matching TODOs. Note: $TAGS will be replaced by the tag list.
上記のセクションもとは、下記でしたが、
..も見てくれるように\\.\\。を追加したのが下記になります。"--"と";"の間に正規表現を追加しています。
((//|#|<!--|;|/\*|^)\s*($TAGS)|^\s*- \[ \])
Escapeせずに書いておりdotが正規表現だったことを思い出したので、この記事を書いた価値はありました。
あと、ユーザー設定とワークスペース設定だと、ワークスペース設定の方が強いのでそこも注意する。
((//|#|<!--|\.\.|;|/\*|^)\s*($TAGS)|^\s*- \[ \])
Discussion