docco
JSDoc
docco | JSDoc | |
---|---|---|
4 | 72 | |
3,557 | 15,123 | |
0.1% | 0.2% | |
0.0 | 9.3 | |
7 months ago | 8 days ago | |
HTML | JavaScript | |
GNU General Public License v3.0 or later | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
docco
-
Ask HN: Show Code with Notes Alongside
i have seen those in annotated javascript documentation. but it was the other way around. (comment on the left, and code on the right).
they all seem to use docco[0] with the option to display comment in "parallel". the author of docco used it in their library underscore[1].
[0]: https://github.com/jashkenas/docco
- Docco is a quick-and-dirty documentation generator
-
Lisp.py
Side note - it's been a while since i've seen a Docco-style annotated-source-style documentation! http://ashkenas.com/docco/
Backbone.js was the first time i saw it, and I loved it! https://backbonejs.org/docs/backbone.html It demonstrated to me that the libraries I use are just normal code that other people write, and i myself can read it to understand a problem.
-
CSS Deep
jashkenas/docco - Literate Programming can be Quick and Dirty.
JSDoc
-
Just Say No to JavaScript
I've seen several ways of annotating Javascript that IDEs seem to understand. They usually involve using comments before fields, classes, or functions.
The most compliant one seems to be using [JSDoc](https://jsdoc.app/). JSDoc is mostly intended for generating documentation. However, the Typescript compiler can validate types (and can even interoperate with Typescript definitions), if you configure it as such.
In scenarios where you HAVE to write raw Javascript but still would like to do some type validation, this is probably the best solution.
It looks a bit like this:
/**
-
TypeScript (and JSDoc) vs JavaScript
If you choose to use JSDoc instead of TypeScript, this only con that TypeScript has is gone, but a new one appears: JSDoc doesnt work very well with more complex types if you dont use classes to represent them.
-
How to document your JavaScript package
Thanks to JSDoc it's easy to write documentation that is coupled with your code and can be consumed by users in a variety of formats. When combined with a modern publishing flow like JSR, you can easily create comprehensive documentation for your package that not only fits within your workflow, but also integrates directly in the tools your users consume your package with. This blog post aims to cover best practices when writing JSDoc-style comments to get your users up and running as quickly as possible:
-
Deep Dive: Google Apps Script - Testing APIs and Automating Sheets
Note: For simplicity, I will omit the JavaScript documentation, but for a production grade code you may want to add the documentation (see jsdoc.app website for more).
-
Figma's Journey to TypeScript
You may like JSDoc[1] if you just want some type-safety from the IDE without the compilation overhead.
It’s done wonders when I’ve had to wrangle poorly commented legacy JavaScript codebases where most of the overhead is tracing what type the input parameters are.
Personally, I’m impartial to TypeScript or JSDoc at this point. But I’d rather have either over plain JavaScript.
[1] https://jsdoc.app/
-
Eloquent JavaScript 4th edition (2024)
I wholeheartedly agree. At most, I introduce JSDoc[1] to newer developers as standardising how parameters and whatnot are commented at least gets you better documentation and _some_ safety without adding any TS knowledge overhead.
[1] https://jsdoc.app/
-
Learn how to document JavaScript/TypeScript code using JSDoc & Typedoc
This is where JSDoc comes to save the day.
-
Add typing to your Javascript code (without Typescript, kinda) ✍🏼
The best way to do this, of course, is with JSDoc. But something I always found awkward about jsdoc is defining the object types in the same file. So, after a lot of reading, I found a way to combine JSDoc with declaration type files from Typescript. Let me give you an example:
-
What is JSDoc and why you may not need typescript for your next project?
There is a lot of specific symbols presented on the JSDOC specification that can be found here: https://jsdoc.app
-
TypeScript Might Not Be Your God: Case Study of Migration from TS to JSDoc
JSDoc is a specification for the comment format in JavaScript. This specification allows developers to describe the structure of their code, data types, function parameters, and much more using special comments. These comments can then be transformed into documentation using appropriate tools.
What are some alternatives?
documentation.js - :book: documentation for modern JavaScript
ESDoc - ESDoc - Good Documentation for JavaScript
Docusaurus - Easy to maintain open source documentation websites.
dox - JavaScript documentation generator for node using markdown and jsdoc
apiDoc - RESTful web API Documentation Generator.
sphinx - The Sphinx documentation generator
jsdox - simplified jsdoc 3
jsduck - Simple JavaScript Duckumentation generator.
YUIDoc - YUI Javascript Documentation Tool