Saturday, October 23, 2010

how author help document for .Net API


simple-talk.com上看到很有价值的一个文章, 在用vs2005/2008编写C#类以及api时候, 我们通常会写一些代码注释, 但如何将这些代码中的注释转换为chm等帮助文档, 一直不太清楚, 下面这篇文章将的很透彻, 需要好好拜读.  作者为Michael Sorens, 他同时也有2个很优秀的开源项目, open-source web sites (cleancode.sourceforge.net andSqlDiffFramework.codeplex.com),  

cleancode包含很多的C#组件, 比如ChameleonRichTextBox语法高亮编辑框, ExtendedDataGridView强大的gridview, SqlEditor很棒的sql 编辑器. 

SQlDiffFramework, 可能对我现在开发的软件, 借鉴意义更大, 不论是代码, 还是feature, 都值得好好学习. 



Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code


Saturday, October 9, 2010