HyperComments Skyrockets Productivity.

Code comments for the 21st century. Did you know, comments didn't change since the 1940s?

Target Audience:

Currently, software developers and engineers are the main target audience, however HyperComments could help a lot for anyone who write a lot of techical literature: scientists, academic people etc.

Overview

I know what you are looking for. You seek for a tool or a framework, or a system that will eliminate all the misery of software engineering, especially when it comes to complex (aka real world, useful) code.

Such complex code with many "nuances" used to be a nightmare to develop and maintain. Not anymore with HyperComments.

HyperComments will save hundreds of workhours, tons of nerves and years of life. However it's still so simple that it hurts.

All it does is allowing you to create "anchors" and "links" inside any files in your project, so you can navigate them easily inside VSCode, just like you would do with regular HyperText inside your browser. Hey, HyperText was a revolution in the world of paper reads, right? Why not do the same inside our software projects? The difference is, HyperComments won't allow broken and incorrect links.

But wait, if you are not impressed, then you truly don't yet understand how it works and what possibilities it opens!

Use cases:

• Document something (like unobvious code) at one place, refer to it from elsewhere.

• Prevent documentation becoming obsolete after refactoring the code.

• Create strong links between different parts of a large project, minimizing the entropy.

• Skip learning how the whole project works, and only learn what you need to finish the task at hand.

• If you are tired of teaching newbies about how your project works, you don't have to now. Just write correct docs once as you write your code, and let the newbies read it instead of distracting you from real work. [no demo, you have to imagine it]

• Keeping things organized.

Soon:

• Revolutionized documentation and tests workflow for really lazy people (or those who want to be super-productive).

Is it free?

It's free for individual and educational use, Open Source Development and for the first 3 users of any commercial organization. Please see the license for details.

Get started

• Just install the extension and you're good to go.

Supported languages and formats:

• Common languages and file formats are supported (js, mjs, ts, txt, md, markdown, tex, cs, rs, rb, go, c, java, class, cpp, cxx, h, hh, hpp, hxx, inc, php, py, html, bat, sh, toml, json, jsonc, ron, has, hs, lisp, lua), but mentioning language identifiers currently supported only for TypeScript and JavaScript.

Coming soon:

• CLI tool to support Continuous Integration workpattern.
• Mentioning code at the next line.
• File system-like paths construction (e.g. go to up-level and mention some anchor there).
• Mentioning language identifiers in C/C++.
• Mentioning language identifiers in Rust.
• One command to generate the always up-to-date, reliable documentation that will also serve as a test suite!
• One command to publish it (or deploy the private one).

Configuration

HyperComments requires no configuration by default.

For advanced usage, you can create a configuration file this way: View -> Command Palette -> HyperComments: Create Configuration File

Miscellaneous

There are a few helper anchors:

//@hcomm:off - disables HyperComments
//@hcomm:on - enables HyperComments
//@hcomm:off,line - disables HyperComments for next line