Reply to thread

Message

<blockquote data-quote="FredP42" data-source="post: 512069" data-attributes="member: 91354">Hello,I agree I think it is a little sad, specially when you look at the amount of code, it is not really easy to read.So here are some suggestions regarding documentations I'm using at work:* There is a very nice and free plugin to help with documentation called <a href="http://submain.com/products/ghostdoc.aspx" target="_blank">GhostDoc</a>. It wiil add a context menu &quot;Document this&quot; when you click on a method or a property. If you name your methods or variable correctly <img src="data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7" class="smilie smilie--sprite smilie--sprite2" alt=";)" title="Wink&nbsp; &nbsp; ;)" loading="lazy" data-shortname=";)" /> it will generate very nice documentation, otherwise it is easy to modify the result.Sadly, it will not work with VS Express (since Express does not support plugins <img src="data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7" class="smilie smilie--sprite smilie--sprite3" alt=":(" title="Frown&nbsp; &nbsp; :(" loading="lazy" data-shortname=":(" />).* It would be nice to generate the XML documentation files (at least Core, Dialog and Utils) and provide them for plugin developers so that the help will show directly in the plugin's solution.* A tool like <a href="http://www.stack.nl/~dimitri/doxygen/" target="_blank">Doxygen</a> can generate nice documentation and can be integrated to the build process to provide an online documentation.Of course all of this is useless if the code is not documented, but I think if you start using such tools it encourages you to improve the documentation, specially with GhostDoc.</blockquote>

[QUOTE="FredP42, post: 512069, member: 91354"] Hello, I agree I think it is a little sad, specially when you look at the amount of code, it is not really easy to read. So here are some suggestions regarding documentations I'm using at work: * There is a very nice and free plugin to help with documentation called [URL="http://submain.com/products/ghostdoc.aspx"]GhostDoc[/URL]. It wiil add a context menu "Document this" when you click on a method or a property. If you name your methods or variable correctly ;) it will generate very nice documentation, otherwise it is easy to modify the result. Sadly, it will not work with VS Express (since Express does not support plugins :(). * It would be nice to generate the XML documentation files (at least Core, Dialog and Utils) and provide them for plugin developers so that the help will show directly in the plugin's solution. * A tool like [URL="http://www.stack.nl/~dimitri/doxygen/"]Doxygen[/URL] can generate nice documentation and can be integrated to the build process to provide an online documentation. Of course all of this is useless if the code is not documented, but I think if you start using such tools it encourages you to improve the documentation, specially with GhostDoc. [/QUOTE]

Verification