開発者の発見のためにAPIをコーディングするアプローチ

Question

私はgreenfieldアプリケーション用に新しいフレームワーク/ apiを開発中です。私の上司が提案した課題の1つは、将来の開発者がコードをナビゲートし、ビジネスのコンテキストでフレームワークをコーディングする方法を発見できるようにするためのフレームワーク/ APIをコーディングすることでした。私たちはIntellisenseのようなものを持つ.NETスタックのツールをベースにして幸いですが、新しい開発者がフレームワークの周りを歩くのに役立つ試行錯誤したコーディング標準を除いて何かがあったのでしょうか？コードを「自己文書化」のように構成することはできますか？

Answer 1

インラインXMLコメントを使用し、SandCastleを使用してプログラムでオンラインドキュメントを生成します。それは「自己文書化」ではありませんが、ドキュメンテーションを作成するのと同じくらい低摩擦です。

StyleCopを使用してこれを（他の良いものも）適用することができます。 Resharperを使用している場合は、StyleCop for Resharperプラグインを使用してこれをリアルタイムで実行することもできます。

Answer 2

構造については、Design Guidelines for Developing Class Libraries