Hyperapp: Source Code Comments Anyone?
First I would like to thank the team for a great developer experience getting started with Hyperapp as a user. The docs are just detailed enough to be useful 馃憤
As a potential contributor I also appreciate how much more approachable the source is compared to projects like React, but there's still enough complexity that I believe measured use of code comments would be of great benefit to us and future you. I'm referring mostly to parts related to events and the VDOM in src/app.js. I know we want to keep this as lean as possible, but comments should be stripped out in minification, right?
okwolf
All 8 comments
@okwolf Still a WIP.
I usually don't like to comment code and I often find myself wasting time thinking about things like writing style, grammar, text justification and other aesthetic considerations.
But Hyperapp has no comments because the code has been in constant flux and it's really a miniature at 250 LOC.
jorgebucaran
on 27 Aug 2017
When I finally get the time to finish the guide, I'll provide the full annotated source with that link and close here. 馃挭
jorgebucaran
on 27 Aug 2017
@JorgeBucaran is there going to be an updated version of this after we release 1.0.0?
okwolf
on 17 Dec 2017
@okwolf Totally.
jorgebucaran
on 17 Dec 2017
@JorgeBucaran _bump_
Has the time arrived yet?
okwolf
on 29 Dec 2017
Haha okay, let me see what I can do 馃槈馃槃馃槒
jorgebucaran
on 29 Dec 2017
I am working on those implementation notes right now! 馃挭
Here is an appetizing gif for the meantime.
jorgebucaran
on 2 Jan 2018
So just going to add that we should focus on patch and maybe functions with optional args.
Since everything else has REALLY good function names. Patch is the hard part, but I don't think set /get/ getKey/setElementProp/copy/etc.. need comments. I think the functions that have optional arguments should have a small comment explaining why (size optimization/optional render).
Patch on the other hand should have comments though. It is a complex function that is more than 8 lines long, and is the meat and bones of how VDOM works (which is what most people want to learn by reading the source anyway).
selfup
on 9 Jan 2018
Related issues
jbrodriguez
路
4Comments
jorgebucaran
路
3Comments
zhaotoday
路
3Comments
jorgebucaran
路
4Comments
zaceno
路
3Comments
Most helpful comment
@okwolf Still a WIP.
I usually don't like to comment code and I often find myself wasting time thinking about things like writing style, grammar, text justification and other aesthetic considerations.
But Hyperapp has no comments because the code has been in constant flux and it's really a miniature at 250 LOC.