私はgreenfieldアプリケーション用に新しいフレームワーク/ apiを開発中です。私の上司が提案した課題の1つは、将来の開発者がコードをナビゲートし、ビジネスのコンテキストでフレームワークをコーディングする方法を発見できるようにするためのフレームワーク/ APIをコーディングすることでした。私たちはIntellisenseのようなものを持つ.NETスタックのツールをベースにして幸いですが、新しい開発者がフレームワークの周りを歩くのに役立つ試行錯誤したコーディング標準を除いて何かがあったのでしょうか?コードを「自己文書化」のように構成することはできますか?開発者の発見のためにAPIをコーディングするアプローチ
1
A
答えて
2
インラインXMLコメントを使用し、SandCastleを使用してプログラムでオンラインドキュメントを生成します。それは「自己文書化」ではありませんが、ドキュメンテーションを作成するのと同じくらい低摩擦です。
StyleCopを使用してこれを(他の良いものも)適用することができます。 Resharperを使用している場合は、StyleCop for Resharperプラグインを使用してこれをリアルタイムで実行することもできます。
1
関連する問題
- 1. 開発者のためのapiとアンドロイドのフォルダのロック
- 2. ウェブ開発者/デザイナーのためのモバイルアプリケーション開発ツール
- 3. Django開発者のためのRails
- 4. web2py開発者のためのDjango
- 5. 初心者のためのモバイル開発
- 6. ASP.Net開発者のためのJSPチュートリアル
- 7. 開発者のためのMercurialコマンド
- 8. ウェブサイト開発者のためのテキストオプション
- 9. 初心者のためのAndroid開発
- 10. WinForms/WPF開発者のためのリソース
- 11. iphoneアプリを開発するためのコーディング標準
- 12. 開発者と非開発者の間でios開発を共有する
- 13. 初心者のためのWebRTCアプリケーションを開発するには?
- 14. 異なる開発者のための異なる「開発」環境
- 15. 開発者のためのフレームワークを構築する方法
- 16. 開発されたソースコードのTDDアプローチ
- 17. Regexの開発者
- 18. 複数プラットフォームの開発者とクロスプラットフォームのゲームを開発する
- 19. 自身のモバイルクライアントのためのセキュアなAPIを開発する
- 20. GPSのようなアプリケーションを開発するための最善のアプローチ
- 21. PHP開発者のためのアンドロイドプログラミングの書籍またはチュートリアル
- 22. Web開発者はAndroid用に開発したい
- 23. .NET開発者に適したネイティブWindows開発プラットフォーム
- 24. Google APIコンソールを他の開発者と共有する方法
- 25. ウェブデザイナーとウェブ開発者のための「サンドボックス」コントロールを保護
- 26. ノンスイング開発者のためのVaadinを学ぶロードマップ
- 27. Eclipseの多くの開発者のためのワークスペースの共有
- 28. Zend Frameworkの開発者から見たDjango
- 29. Java開発者のためのEclipseでの.classファイルの使用
- 30. NONのゲーム開発者のための物理ベースのアニメーション