If you’re starting out with object and array manipulations in JavaScript these handy tools by Sarah Drasner might come in handy. The reason they work so well is that it’s one page, and it’s driven by natural language. JavaScript Object Explorer →JavaScript Array Explorer → Do not however that the yielded code mutate the original …
Tag Archives: documentation
15 Ways to Write Self-documenting JavaScript
A few handy pointers to keeping your code readable: Some programmers include comments as part of self-documenting code. In this article, we’ll only focus on code. Comments are important, but they’re a large topic to be covered separately. We can split the techniques for self-documenting code into three broad categories: structural, where the structure of …
Continue reading “15 Ways to Write Self-documenting JavaScript”
Slate – Beautiful static documentation for your API
Swagger
Speaking of APIs and documentation in the previous post: Swagger is a specification and complete framework implementation for describing, producing, consuming, and visualizing RESTful web services. Describe your API in a JSON file like this, and Swagger will turn it into that. Alternatively you can provide your project with Swagger Annotations and then run it …