How to improve codebase knowledge? on a large complex CSharp codebase. RRS feed

  • General discussion

  • (I couldn't find an exact forum on msdn for this topic, hope this is the place).

    What do other groups out there use to document their CSharp codebase?

    We've inherited a very complex codebase and only 2 out of 6 members understand the flow in detail. How can we improve the groups knowledge, where do we start?

    We're talking 10s of thousands of lines of code broken into 2 main projects.

    The code itself is difficult to understand, contains alot of Delegates which makes the Debugging a nightmare.

    Creating new Design Documents has been mentioned but in my experience this is rarely of benefit as the code detail is much more complex than the design and when trying to provide a graphical representation at a detailed enough level to be useful it's nearly the same as writing the code itself.
    I feel some description in english and Use Cases are what we need, but where do we start?

    We're using VS 2005 with TFS, code is all CSharp.

    Tuesday, September 2, 2008 10:30 AM

All replies

  • You might find this book helpful.


    I haven't yet read it all (or applied it in fact) but it seems to have lots of useful suggestions. What happened is I bought it just before my last contract. Then my contract started and I didn't have time to look at it. But now I'm "resting" again so I was able to spend more time on it. I shall certainly be making use of it when I next find myself in your situation.

    Tuesday, September 2, 2008 10:47 AM