⏳ “Chronicon Publicis” 📰
Welcome to the public personal＆professional “development” journal of B.F. Griffith, where you can peruse assorted reverse-chronological sporadic reflections documenting his progress over time as a practitioner of web-development＋software-engineering as well as a variety of other creative disciplines, hobbies, or significant “milestone” achievements he happens to feel especially passionate about or motivated to occasionally commemorate!
Week Four ➙ Iron Yard Tutorial Journal
29 May 2015DOC-block commentary, basic tutorial:
This is an important piece of syntax and planning-structure that I learned this week. It works well in Atom or most other text-editors, is intuitive and easy to type (using a comment and Markdown sort of syntax), and can be used by jsdoc to create some very nice documentation… (an index of @-terms this format will accept are at the previous link, and a simple example is below…)
/**
* @param {Array} someFunction <explain what this function means, enumerate arguments...>
* @return { ... }
*/
Installation instructions are here. More information is here.
Personally, as a newbie to JavaScript, I found learning this format not only a best practice that I should get in the habit of doing when appropriate on the job (with particularly complex of important functions, at least), but also quite helpful for planning implementation of User-Stories into functions.