Documenting your work - how?

leprechaun · Post by **leprechaun** » 30 Jun 2004 09:36

How you do this when working with big projects? Regardless of languages used (VB, Java, etc). If you have, say, 1000 classess in your project, it's not easy to figure out how they work together. What functionality is already present and can be reused and what must be created from scratch? What is the purpose of this or that class/method? What are the dependencies for this piece of code? Questions like these. Are there any commonly-used tools for creating this kind of documentation? I know in Java you can use JavaDoc but it's Java-specific and tightly-coupled (comments embedded in code) while I'd prefer a language-independent tool. The only thing which comes to mind is WinHelp or Compiled HTML. It produces a compact and intuitive documentation. Anything else?

Nervous · Post by **Nervous** » 30 Jun 2004 14:48

Doxygen?

leprechaun · Post by **leprechaun** » 30 Jun 2004 16:11

Nervous wrote:Doxygen?

Looks like another sourceforge offspring. Not much different from JavaDoc. If you're using it (are you?), can you tell its benefits?

geek7 · Post by **geek7** » 30 Jun 2004 16:53

leprechaun wrote:How you do this when working with big projects? Regardless of languages used (VB, Java, etc). If you have, say, 1000 classess in your project, it's not easy to figure out how they work together. What functionality is already present and can be reused and what must be created from scratch? What is the purpose of this or that class/method? What are the dependencies for this piece of code? Questions like these. Are there any commonly-used tools for creating this kind of documentation?

Tugether
Большой проект + RUP возможно имеет смысл использовать Rational. IMHO для developer-а Together как-то ближе, но по полной программе от reqirements до контроля версий Rational это круто
все так заинтегрированно, что можно связать BR c HiLevel OM с физической OM с собствено кодом etc.
Опять же документацию по модели генерить приятно.. ещеб он как Together forvard/reverse на лету делал. :roll:

geek7 · Post by **geek7** » 30 Jun 2004 16:55

leprechaun wrote:How you do this when working with big projects? Regardless of languages used (VB, Java, etc). If you have, say, 1000 classess in your project, it's not easy to figure out how they work together. What functionality is already present and can be reused and what must be created from scratch? What is the purpose of this or that class/method? What are the dependencies for this piece of code? Questions like these. Are there any commonly-used tools for creating this kind of documentation?

Tugether
Большой проект + RUP возможно имеет смысл использовать Rational. IMHO для developer-а Together как-то ближе, но по полной программе от reqirements до контроля версий Rational это круто
все так заинтегрированно, что можно связать BR c HiLevel OM с физической OM с собствено кодом etc.
Опять же документацию по модели генерить приятно.. ещеб он как Together forvard/reverse на лету делал. :roll:

Nervous · Post by **Nervous** » 01 Jul 2004 02:09

leprechaun wrote:
Nervous wrote:Doxygen?

Looks like another sourceforge offspring. Not much different from JavaDoc. If you're using it (are you?), can you tell its benefits?

Правильно. Но языконезависимый JavaDoc. Вас вроде это надо было? Мы используем для С/С++.

leprechaun · Post by **leprechaun** » 09 Jul 2004 11:23

Thanks for the pointers. Trying Together at the moment and it looks nice except for one thing. If I create an HTML documentation for a big project, how can I update only a part of it? Say, one package? Regenerating it from scratch takes a while but if I try to do it only for the selected package, it loses all the dependency links to other packages. I'm probably missing something, right?

Привет

Documenting your work - how?

Documenting your work - how?

Re: Documenting your work - how?

Re: Documenting your work - how?