Gabriele Ferro Home

Boring topics

Day 63: 15 October 2020

**Today’s Progress:**

Yesterday I finished writing the code for the fifth project but in order to present it I have to comment the code and also I have to write a test plan with a minimum of 80% test coverage.

If we do not count some comments left in the code as post-its, I can say that I have never done either activity.

For this reason I had to document myself. Luckily there is Google.

About ten years ago, I studied Java at university and we were "taught" JavaDoc… and I discovered that there is the equivalent for almost every programming language.

For JavaScript is called JSDoc:

JSDoc 3 is an API documentation generator for JavaScript, similar to Javadoc or phpDocumentor. You add documentation comments directly to your source code, right alongside the code itself. The JSDoc tool will scan your source code and generate an HTML documentation website for you.

JSDoc - Getting Started

Following javascript.info and the standards suggested by WordPress, I have inserted the comments.

The amount of work exceeded my initial estimate, so much so that it took me hours to write some concise and strictly necessary comments.


As for the test plan, I didn't even have a vague idea of what I should write or what format I should use.

Fortunately only one site had all the answers I was looking for: Guru99.

I discovered what a test plan is and especially its usefulness.

The differences between Unit Testing and Functional Testing and what Code Coverage is.

**Thoughts:**

In short, boring topics.

**Link to tweet:**

[twitter-follow screen_name='20Gabriele20']

February 2024
MTWTFSS
 1234
567891011
12131415161718
19202122232425
26272829 

Archives

Gabriele Ferro Home
Copyright © Ferro Gabriele. All rights reserved.