Hi, Emma! Thank you for your interest! Currently there's an extension only for VSCode (and VSCode-based editors). However, if you use the HyperComments notation, then, even if you use the other editors, it's still easier to find defintions of concepts, e.g. you search for @Hadron and you get exactly one search result - which is the definition.
Yep, JavaDoc is one. Then you have JSDoc for JS, which is almost dead, TSDoc for TS, which arguably sucks and was unmaintained last time I checked. For Rust there's RustDoc which is the closest thing to HyperComments, but again, IDE support is close to non-existent and it's less ergonomic [title](anchor_name).
So, I've spent more than a year for research and didn't find anything good. So I'd say that HyperComments could be a new standard, why not? Actually that's exactly what I am going to make happen. This is what's coming soon:
Automatic Completion
Configuring (including/excluding) files that should be analyzed.
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).
Hi, Emma! Thank you for your interest! Currently there's an extension only for VSCode (and VSCode-based editors). However, if you use the HyperComments notation, then, even if you use the other editors, it's still easier to find defintions of concepts, e.g. you search for
@Hadronand you get exactly one search result - which is the definition.Yep, JavaDoc is one. Then you have JSDoc for JS, which is almost dead, TSDoc for TS, which arguably sucks and was unmaintained last time I checked. For Rust there's RustDoc which is the closest thing to HyperComments, but again, IDE support is close to non-existent and it's less ergonomic
[title](anchor_name).So, I've spent more than a year for research and didn't find anything good. So I'd say that HyperComments could be a new standard, why not? Actually that's exactly what I am going to make happen. This is what's coming soon:
Looks like you've put a lot of thought into it. Good luck!
Indeed. Thanks :-) By the way, what's are the other editors that your teammates use?
Sublime text and IntelliJ
Thanks!