2009-04-01 11 views
-1

構造がよく文書化されているAPI(C#でコード化されています)のドキュメントの良い例を探しています。良いドキュメントの例はどこにありますか?

が含まれている必要があります

  • 代表
  • イベント
  • 列挙
  • クラス
  • 構造体

を今、私はhttp://code.google.comを検索していますが、今のところ私が持っています何も分かりません。

+0

あなたは何のドキュメントですか? –

+0

.NET Frameworkはどうですか? :) – OregonGhost

+0

しかし、私は規模で何か小さいものをしたい... –

答えて

2

まあ、(コメント)であれば、あなただけのコードサンプルの後にある - protobuf-netの公開APIは、ドキュメンテーションコメントの合理的な量を持っています

struct秒を書くことは珍しいです、そして原因いるProtobufネットの性質のために多くのイベントを使用していない - しかし、あなたのアイデアを得ます。

これらは、intellisenseを提供するために、dllの横にxmlファイルで(もちろん)出荷されます。私はそれに対して砂浜を走らせることができた - 私は必要性を感じなかった。

+0

あなたはどのように著者とバージョンを指定しますか?おかげで –

+0

プロジェクトですか? AssemblyInfo.cs;ファイルのために?私はおそらく共通のヘッダーを追加する必要があります - 私はしていない。 Resharperはそれを助けることができます。変更履歴ベースでは、IMOのコードリポジトリ(この場合はSVN)がそのデータを所有しています。 –

関連する問題