より良いtodosを書く5つの先端

我々は、すべての一度に毎回、恐ろしく// TODO:と// FIXME:コメントを書きます.時々、我々は我々のコードがよりよくありえるということを知っているので、我々はそれをします、しかし、我々は方法を確信していません、我々には期限のために最適解を書く時間がありません、そして、他の時間は我々がちょうどより多くのおもしろい問題に解決するために動きたいです、そして、我々はちょうど我々のコードに// TODO:を平手打ちして、それを1日と呼びます.
今日のポストでは、私はあなたのtodosが最終的に固定されるようにするためにあなたに5つのヒントを与えたいです、そして、あなたのコードを時間の終わりまで気づかれないようにしてください.

1 .日付と名前を使用して、ToDoに署名します
最初のヒントはおそらく私の意見で最も重要です.あなたのコードでToDoを残すならば、あなたの名前と現在の日付でそれに署名してください.これは本当にあなたとあなたのチームの誰がどのくらいのtodoがそこにされているどのようにそこに任天堂を残して明確になります.TODOがまだ関連しているならば、非難ゲームをするか、指を指さしてください、しかし、元のTODOライターを尋ねるためにより多くの指に、そして、あなたが使用しなければならないどんな仕事においてもJIRAチケット、Trelloチケットまたは他の種類のチケットがあるかどうか、目的は遊びます.
また、ToDoの著者と日付をgitから抽出することも可能ですが、これは時々問題が発生することができます特にtodoでマークされたコードが動かされている場合、またはtodoは全体の歴史を運ぶので、typoが固定されています.これは、はるかに便利なToDoアイテムを一目で利用可能な基本的な情報を持っている.

2 .あなたのtodoを残忍でマークする
あなたのプロジェクトが非常に少ない警告をして、あなたのプロジェクトでXcodeが示す警告に注意を払う傾向があるならば、あなたのtodosがコンパイラ警告として現れるのは良い考えです.次のようにして、次のように書くことができます.

#warning("TODO: donnywals, 2020-01-08 - Improve this algorithm, I'm sure we can get this to O(1) somehow.")

コメントではなく#warningとしてTODOを書くと、Xcodeはコンパイラの警告として扱います.これは、あなたのTodosがさらに目立つようになります、そして、先端1と結合されるとき、あなたは彼らが警告として現れるので、あなたのTodosが簡単に見えるようになるでしょう、そして、あなたが警告において夜そこにあるかもしれないすべての文脈があります.

警告を使用するには、#warningを使用する代わりに、SwiftLintを使用することです.SwiftLintは、あなたとあなたのチームがあなたのコードを分析し、そのルールのいずれかに違反したときにコンパイラの警告を示すことによってきれいにフォーマットされた迅速なコードを記述するのに役立ちますツールです.SwiftLintには、コンパイラの警告として// TODOコメントの出現箇所が表示されます.
あなたがコメントを好むので、あなたのTotal #warningを使用したくないならば、また、あなたのコードでどんなtodosについても警告されたいならば、SwiftLintは行く方法です.

4 .しばらくしないとトッドを取り除く
固定されることがない永遠のToDoアイテムを避けるために、必ず行って、しばらくずつあなたのTodosをきれいにしてください.あなたが著者と日付を使用してあなたのtodosをマークする場合、それはtodosはあまりにも長い間のために残っているし、すぐにあなたのチームメイトにtodoのステータスは何かを見つけるために手を差し伸べることができるかどうかはまだ関係があるかを見つけるのは簡単です.
ここでの良いアプローチは、1週間以上何週間も休むことです.私が働いているプロジェクトを通過するために、私が働いているプロジェクトを通過することです.私は、TODOが1ヵ月か2年以上の間、まわりにいたとき、彼らがしばしば無関係になると気がつきました、あるいは、私はtodoを実行することがまだ優先されていないと理解します.これは、TODOがもはや関連していないので、しばしばそれが優先されているtodoにつながるか、それを取り除きます.

5 .一緒にtodosを避ける
これは少し不正行為ですが、より良い方法を持っている最善の方法は、完全にそれらを避けるためです.あなた自身がtodoを書くとわかるときはいつでも、なぜあなた自身を尋ねてください.多くの場合、答えは、次のことに移動するか、またはあなたがしたいことを行うにはわからないので、多くの理由は、あなたが今すぐに把握することを決定しないことを確認します.多くの場合、あなたはすぐに行って、すぐにされる必要があることをして、todoを完全に書くのを避けるだけであるかもしれません.
あなたがチームメイトのうちの1つからPRを検討していて、彼らのコードでtodoを見つけるならば、TODOがなぜそこにあるかについて、彼らに尋ねるために全くOKです、そして、将来においてではなく、むしろTODOの世話をするよう彼らを説得しようとします.TODOが合理的であるならば、TODOがあなたのチケットシステムに仕事が優先されるのを確実にするためにあなたのチケット交換システムに加えられるならば、todoが完成するようにマークされることができるかどうか突き止めてみてください.

要約する
私は、この方法のリストをより良いあなたのcodebaseを改善することができますtodo項目を書くことを得ることを願っています.ほとんどのコードベースでは必然的にtodosは避けられませんが、あなたのコードに隠されたtodosをたくさん持っていないことを避けるためにうまく管理できます.
もしあなたのプロジェクトのToDoSを処理する方法についてのヒントがあれば、確認してください!