开发者

Source Code Documentation tool

开发者 https://www.devze.com 2023-03-09 05:21 出处:网络
Can a开发者_如何学Gony one suggest a source code documentation tool for VB.NET 10 ? Thanks.use open source Sandcastle for documentation of .net codeGhostDoc is what I use.Great tool.If you want your

Can a开发者_如何学Gony one suggest a source code documentation tool for VB.NET 10 ?

Thanks.


use open source Sandcastle for documentation of .net code


GhostDoc is what I use. Great tool.


If you want your documentation to contain anything except the things that are already obvious from the signature, the only useful tool here is... you. That and some /// (C#) or ''' (VB) fun. There are tools that will generate things like "gets or sets the FrobCount", but ultimately... what did you think the FrobCount {get;set;} property did?

BTW, by this I don't mean "don't bother adding those comments" - they do have some sense... but my concern is that you get into the habit of just using the automatic tooling. Ultimately, this adds very little extra value. The value comes from knowledge about the semantics, expected usage, side-effects etc. No automated tool will generate that.


We use DocumentX.

0

精彩评论

暂无评论...
验证码 换一张
取 消