ドキュメンテーション

2006-02-24 [ものがたり]

トラックバックを頂いたのだが、現在はコメントできる環境に無いので、この場で言及。

NDocは全く知らないしcsc /doc sucksでmonodocerとmonodocs2htmlで事足りている僕としては、特に大きな興味はないのだけど*1、何でローカリゼーションが必要なんでしょう。
[2006-02-24 ものがたりより引用]

過去の日記で書きましたが、こと、NDocに関しては英語版のままだと変換用XSLT内で多用されている"&#160"が全て文字化けするんですよね。ローカライズの目的の一つはこれを解消するためではないでしょうか。
後日、結果として"&#160"を他の適当な空白にすれば、文字化けの問題に対象するだけなら、コードでのローカライズは不要だということは証明できました。あと、現版である「未対策」のv1.3.1は.NET2.0環境上でGenericsを使用したクラスのドキュメントを作ろうとした場合、NDocビルドが通りません。

NDocにこだわるのはMSDNに極めて近い見た目が得られるから、ですかね。個人的には別にmonodocでも全然Okですけど。

これは日頃からやや疑問なのだけど、.net/Java開発者の皆さんはホントにjavadocみたいなのが良いと思っているのかなあ。
[2006-02-24 ものがたりより引用]

私も、決してjavadocのようなものが最良とは思っていませんけど、

  • 既成事実として、一応デファクトなフォーマットである
  • javacとjavadocソースコードさえあれば、どんな環境でも自動生成できる
  • Eclipse等のIDEのお蔭で、更に簡単に自動生成できる

以上の流れで使われている(顧客から納入を要求される)だけ、というのが現実でしょうね。