question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Source Code Comments Anyone?

See original GitHub issue

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?

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Reactions:10
  • Comments:8 (8 by maintainers)

github_iconTop GitHub Comments

9reactions
jorgebucarancommented, Oct 11, 2017

@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.

8reactions
jorgebucarancommented, Jan 2, 2018

I am working on those implementation notes right now! 💪

Here is an appetizing gif for the meantime.

2018-01-02 12 54 52

Read more comments on GitHub >

github_iconTop Results From Across the Web

Best practices for writing code comments - Stack Overflow Blog
Rule 5: Explain unidiomatic code in comments. It's a good idea to comment code that someone else might consider unneeded or redundant, such...
Read more >
Source Code Comments, Fields of study, Abstract, Principal ...
Source code comments are annotations that are used to explain the purpose and structure of a computer program's code. The use of appropriate...
Read more >
Ridiculous Comments In The Source Code That ... - YouTube
Human thoughts can be so weird sometimes. And the minds of programmers are more creative when it comes to writing comments.
Read more >
Putting comments in code: the good, the bad, and the ugly.
Documentation comments are intended for anyone who is likely to consume your source code, but not likely to read through it.
Read more >
8 Types Of Source Code Comments
Documentation comments are intended for anyone likely to consume your source code, but not likely to read through all of it it.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found