Visual Studio

[VS]ソースコードをタスク管理として使う

投稿日:2018年9月16日 更新日:

Visual Studio

タスクチェックの画像
どうも@EaEです!

はい、また1週間が経過しましたw

なんなんでしょう。この速さはw そうこう言っているうちに年末になってしまいそうですね。

さて、今日は記念すべき技術的まとめになりますw

「こんな内容かよ...」とか言われそうですが...

今日はVisual Studio 2017を使ったタスク・TODO管理について紹介したいと思います。

知っている人にとっては当たり前の内容かも知れません!

ですが、最近知り合いと話していて、案外知らない人がいたので、まとめてみました!

対象は無償で利用できる Visual Studio 2017 Communityを使います。特に追加するものもなく、標準で備わっている機能を使っていきます!

実際に使うのは、「タスク一覧」と呼ばれる機能です。

その名が示す通り、タスクの一覧を表示する機能ですが、ただメモ帳のようにタスクを書いていくわけではありません。

コードの中に指定のトークンを埋め込むことで、

ソースコード内にタスクを記述していきます。

ソースコードレビューをする際に以外と手間なのが、レビュー内容と対応をどこで管理するかという問題です。

Redmineに起票するほどの内容でもない。だが、レビューの対応をして修正してもらわないと困る。

そういった内容をエディタにまとめて管理していましたが、

以外と修正漏れが多かったり、指摘箇所のソースをたどるが大変だったりしていました。

そこで、このタスク一覧を使い始めましたが、今ではこれがないと不便でたまりません!!

それでは実際にタスク一覧の使い方について、はじめていきます!

1.タスク一覧の表示

恐らく、初めてVisual Studioを起動した場合には、「タスク一覧」が表示されていないはずなので、まずは[タスク一覧]のWindowを表示させていきます。

[表示(V)]を選択すると、中に[タスク一覧(K)]があるので、それをクリックします。

タスク一覧の選択画面

[表示] > [タスク一覧]を選択する。

[タスク一覧]を選択すると下部のWindow画面に[タスク一覧]のタブが追加されます。

タスク一覧が表示された画面

下部のWindowに[タスク一覧]のタブが追加される。初回表示の際は何も表示されない。

初期表示の画面では、何もタスクを追加していない状態なので、何も表示されませんが間違いではありません!

2.タスクを追加する

ここまで準備ができたら、実際にタスクを追加していきます。

タスクを追加する.csファイルを開いて、[//]コメントタグの後ろに[TODO]というトークンを記載していきます。

トークンがタスクとして表示されている画像

TODOトークンを使って記載した内容がタスク一覧に反映される。

これだけでタスクの追加は完了です!

非常に簡単です!

タスク一覧には、記載されているファイル、行だけではなく、実際にタスクを選択すると、指定されたファイルの行に移動することもできます。

使用できるトークンは[TODO]だけではなく、デフォルトで[HACK]、[UNDONE]が定義されています。

これ以外にも [ツール(T)] > [オプション(O)] > [環境] > [タスク一覧]の画面から、カスタムトークンを増やすことができます。

カスタムトークン追加画面

運用方法などに合わせて、トークンを追加・変更することができる。

3.タスク一覧を使った運用例

最後は実際にタスク一覧をどうやって使っていくのかということですね!

タスク一覧を使用する前段階として、Git,SvnといったVersion管理が行われていることが望ましいです。

実際のソースコードにタスクを記載していくので、Version管理が行われていない状態では、記載されたタスクを消されてしまった場合に辿るすべがありません。

(Version管理が行われていない現場はそうそうないので、あまり心配いらないですかねw)

 

さて、余談もこれくらいにして、私が実際に行っている運用方法はデフォルトの[TODO]、[UNDONE]に[REVIEW]トークンを追加しています。

コードレビューの場合には、[REVIEW]トークンを使用して、コメントを記載していきます。

REVIEWトークンの使い方画像

レビュー番号とレビュー内容を記載して運用しています。

[TODO]トークンはRedmineのチケット番号と、コメントを記載して運用しています。

TODOトークンの使い方画像

Redmineのチケット番号と対応内容、次のチケット担当者も記載するようにしています。

バグ対応で回収を入れた部分の目印、テスト担当者に場所と改修意図を伝える目的で[UNDONE]を使用しています。

これは[TODO]トークンとの使い分けが難しいところで、テスト担当者へ向けてという目的のみで自分たちは使っています。

UNDONEトークンの使い方画像

修正内容などを記載しています。これは、TODOと使い分けが難しいところです。

以上、簡単ではありますが、Visual Studioを使ったタスク管理についてまとめてました。

Version管理ツールやプロジェクト管理ツールを合わせて使用することで、非常に楽にタスク管理を実現できます。

コーディングに夢中になっていると他のプロジェクト管理ツールとかを見るのが億劫になってしまうことがあります...

自分がそうなだけにメンバーにもあまり強く言えないので、このような方法を取るようになりましたが、意外と好評だったので、

皆さんもよければ使ってみてください!

 

詳しくは以下のサイトにも掲載されているので、ぜひ一読してみてください。

タスク一覧の使用 - MSDN - Microsoft

それでは、次回!

  • この記事を書いた人

@EaE

ぬこ様とC#をこよなく愛する27歳です. 医療:理学療法士から、IT:システムエンジニアへ華麗?な変身をとげました. サーバーサイドエンジニアとして、日々奮闘しています. 今年の目標は、頑張ってWebサービスを作ります!!

-Visual Studio

Copyright© Developer Wall - 開発の壁 - , 2019 All Rights Reserved Powered by AFFINGER5.