前提条件
この方法は、分散バージョン管理システム(git、mercurial、bazaar)を使用し、ブランチの機能/タスク/バグ(たとえば、gitflow)を開発するための実装された方法論を使用する小さなチームにとって興味深いものになります。 チームのコードエディターは、特定のキーワード(TODOなど)のコメントの解析をサポートしています。 コードをレビューするための完全に機能する専用ツールは、支払われており、予算に余裕がないため、実装できません。 無料ですが、簡単にインストールできないか、疑わしい使いやすさがある または特定のケースでは、彼らはスズメの大砲かもしれません。
プロセス
一般的なアイデアは、機能(バグ、タスク)が個別のブランチ(gitflow)で開発され、特定のサーバーで公開されるというものです。 レビュー担当者は、TODOスタイルでコメントを書き込みますが、「REV」などの特別なタグを使用します。
$ourcoolcode = 123; // REV ? echo $ourcoolcode;
コメント構文
コメントは、特定の言語に応じて、単一行または複数行のいずれかになります。
/** * $TAG $status $title * $commentor1 $comments * $commentorN $comments */
- $ TAG-プロジェクトコードに固有で、TODOではなく、XXXなどではなく、たとえば、REV。 現在のプロジェクトコードのコメントに存在しないようにする必要があります。
- $ status-ステータスを示すことができるオプションのパラメーター:「+」-質問が閉じられたか、問題が解決されました。 「!」-問題があり、文字数は問題の重大度を示すことができます。
- $ title-質問/問題のタイトル。
- $ commentor1 / $ commentorN- (オプション)一部のコメントを他のコメントと区別するためのコメンテーターの指定。
- $コメント -すべてがタイトルに収まらない場合の質問/問題の作成者のコメント、または回答した人のコメント。
コメントは、特定の言語に応じて、単一行または複数行のいずれかになります。

真空での抽象的な例
長所と短所
この方法の利点:
- 最小実装コスト-絶対にネイティブなツールが使用されます-標準設定/プラグインとバージョン管理システムを備えたエディター。
- 質問や欠陥はエディターですぐに表示されます。
- 飛行機で動作します(:gitや他のdvcsのように)。
- コードを使用する場合、比較モードを開き、変更内容を確認して、ここに特別なコメントを書くことができます
そしてもちろん、デメリット(回避策あり):
- ひざまずき、今では特定のツールではなく、エディターをセットアップし、リポジトリにフックを配置しているという事実: フックは一度書くだけでgithubに置くことができます。 また、ツールのチューニングについて一度説明し、ウィキを画像とともにgithubにアップロードします。
- いくつかの規律を維持し、通常のツールでは単純に強制される慣習に従う必要がありますが、フックの助けを借りてすべてを完全に整理することができます : コメントを残すことができますか? 開発/マスターでそれらとのコミットを許可しないでください。 「左」コミットでコミットログが詰まることはありますか? それらを圧縮し、すでにいっぱいのものをメインブランチに注ぎます。
- 長いコメントや議論の構文と問題。
- 履歴の保存: オプションとして、最後のコミットで、ボディをさらに作成し、議論された内容とその目的をペイントします。
おわりに
この方法は、単一の最も正しい方法として提案されているのではなく、特定の条件下での選択肢の1つであることを強調します。 同様のものを知っているか、すでに使用しているが、正式化していない場合は、大胆に説明してください。メソッドの改善も歓迎します。 この方法があなたに合わない場合でも、おそらく他のアイデアを促します。