[nem-en] Re: Re[2]: Documentation comments clarification and proposals[Long]

Ildar Mulyukov ildar at users.sourceforge.net
Mon Nov 13 05:38:33 CET 2006


On 12.11.2006 01:33:29, Michal Moskal wrote:
> On 11/11/06, Igor Tkachev <it at rsdn.ru> wrote:
>>>  Otherwise (external) it is harder to check correctness (you will   
>>> almost always  need a good deal of parsing to do that) and it will  
>>> soon become  obsolete.
>> 
>> The correctness should be checked by the compiler. It works like an
>> include.
> 
>  The point is that when you change the semantics of a method and see  
> a  documentation comment stating the old semantics, you're more  
> likely  to  change it, than if it hangs around somewhere in external  
> file.

	Hello, Michal!
I agree that in nemerle ABI is much more subject to change than Mono.  
But using monodoc it's fairly easy to update changes in docs. You just  
make the same: $ monodocer -path:. -assembly:lib.dll
See  
http://mono-project.com/Generating_Documentation#Synchronize_Documentation_with_source_code

Even robot can do it.

BR. Ildar
-- 
Ildar  Mulyukov,  free SW designer/programmer
================================================
email: ildar at users.sourceforge.net
projects: http://os-development.sourceforge.net/
home: http://tuganger.narod.ru/
ALT Linux Sisyphus
================================================



More information about the devel-en mailing list