NDoc: How to Make Good Use of Your XML Comments?

Writen by Allen Lee

Requirement

使用C#进行库的开发。

在源代码里使用XML注释。

厌倦额外的文档编制工作，希望有无怨无悔的电脑接手这份枯燥无味的工作。

具备C#的开发条件，至少需要.NET Framework SDK 1.1。

能尽量抑制你的瞌睡虫，不让它阻碍你阅读本文。

其它...

Encountered Problems

面向对象技术的普及，为我们带来了极大的便利。对象的重用减轻了我们编码时许多不必要的痛苦，清晰的代码责任分离制免除了我们每顿都要面对着意大利粉的厌恶。

但是，我们仍然要面对着枯燥的文档编制从内容构思到页面排版。相信库开发人员对这种厌恶已经深有感触，即使我们都承认文档的重要性。 当然，某些大企业有专人写文档，但最了解库的却是程序员自己！而程序员往往又会在自己开发的库中为代码添加注释，如果有个工具能够利用这些注释按照一定的格式要求直接导出文档该多好呀！

聪明而懒惰的程序员总是比其他人先行一步，他们不愿把自己放进重复而枯燥的方框内，他们千方百计要跳出这个方框，让自己能够从事更富创造性的活动，把这些枯燥无味的扔给无怨无悔的电脑们。

Feel Free to Write Your Class Library With XML Comments Added

单纯的文字无法让你领略NDoc的魅力，至少我还没有这个能力。睡着了吗？（或许周公的故事更加有趣！）还没有的话请看看下面这段示范代码一个表示复数的类（class）。

using