[Monodevelop-devel] XML Doc Comments in MD Source

[Levi Bard]

On Tue, Aug 18, 2009 at 10:08 AM, Michael
Hutchinson<m.j.hutchinson at gmail.com> wrote:
> I've been wondering whether we should re-evaluate our policy regarding
> XML doc comments in MonoDevelop source. I would argue that we should
> use doc comments in MD for a number of reasons. MD is a very different
> case to the Mono classlibs -- the MD APIs are often only well
> understood by the person who writes them, there are no alternative
> sources of documentation, and the API is less stable.
>
> For these reason, I think it is important to lower the barrier as much
> as possible for getting docs from the people who are creating and
> changing the APIs, so that we can improve the sorry state of our
> documentation with minimal effort.

I agree completely.
In addition, those that find the doc comment blocks ugly can make use
of the "Fold comments by default" preference in the text editor
settings (in fact, I believe that setting is enabled by default).


-- 
http://homes.eff.org/~barlow/EconomyOfIdeas.html
http://www.dreamsongs.com/MobSoftware.html
http://www.gnu.org/philosophy/shouldbefree.html