[Lazarus] Lazarus Digest, Vol 99, Issue 32

Juha Manninen juha.manninen62 at gmail.com
Sat Apr 9 16:41:18 CEST 2016


On Sat, Apr 9, 2016 at 5:18 PM, Michael Thompson
<mike.cornflake at gmail.com> wrote:
> You say minimal, code analysis says Average.

Comments are overrated.
If you think of them as "deodorant masking fishy code" then less
comments is better.
What would really help are high level documents of IDE internals.
Diagrams and textual description. My favorite diagram is Sequence
Diagram because it shows both actors and cronological order.
Such documents would help only (potential) developers of the IDE, but
that is already very useful.
Why is it not done?
I think because they help only initially when learning certain code.
The same understanding comes from reading and browsing code, but it
takes longer time.
That's why the developer who knows the code has only little motivation
to draw diagrams.
Anyway, after the initial understanding is got, everybody must read the code.
Thus diagrams are not necessary but the sure would make the project
more attractive to new potential developers.

Are you good in drawing diagrams?

Juha




More information about the Lazarus mailing list