You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We'd like to make good code so we can generate as much doc as possible.
If something is intuitive enough, then it takes less work to write the doc to explain it.
Also, we would rather not copy and paste the function names for each object.
There are UML generators that can parse the source code and give you at least the signature (which is a good starting poing).
I mean, this a function signature in UML, you can't copy it from the code because the types are wrote on the opposite side
functionABC(parA: Type, parB: Type): ReturnType
So you want the parser to do that, and concentrate on writing the actual description.
Candidates:
Doxygen (this is quite powerful)
WhiteStarUML (easy to use)
...
The text was updated successfully, but these errors were encountered:
We'd like to make good code so we can generate as much doc as possible.
If something is intuitive enough, then it takes less work to write the doc
to explain it.
Also, we would rather not copy and paste the function names for each
object.
There are UML generators that can parse the source code and give you at
least the signature (which is a good starting poing).
I mean, this a function signature in UML, you can't copy it from the code
because the types are wrote on the opposite side
functionABC(parA: Type, parB: Type): ReturnType
So you want the parser to do that, and concentrate on writing the actual
description.
Candidates:
Doxygen (this is quite powerful)
WhiteStarUML (easy to use)
...
—
Reply to this email directly or view it on GitHubhttps://github.com//issues/42
.
We'd like to make good code so we can generate as much doc as possible.
If something is intuitive enough, then it takes less work to write the doc to explain it.
Also, we would rather not copy and paste the function names for each object.
There are UML generators that can parse the source code and give you at least the signature (which is a good starting poing).
I mean, this a function signature in UML, you can't copy it from the code because the types are wrote on the opposite side
functionABC(parA: Type, parB: Type): ReturnType
So you want the parser to do that, and concentrate on writing the actual description.
Candidates:
Doxygen (this is quite powerful)
WhiteStarUML (easy to use)
...
The text was updated successfully, but these errors were encountered: