Tirer profit son éditeur de code
Tirer profit son éditeur de code.
Il y a deux semaines j’ai commencé à documenter les packages de l’éditeur de blocs de WordPress, Gutenberg. C’est l’une des choses que je fais quotidiennement donc depuis que j’ai commencé.
En pratique, voilà un exemple de pull request d’une documentation que je publie.
Aux débuts, j’avais du mal à identifier correctement soit les définitions des fonctions que je devais documenter, leurs propriétés, etc…
Puis ce matin, en travaillant, j’ai (par hasard) survolé l’une de ces fonctions dans mon éditeur (j’utilise VS Code); et que vois-je ?
L’éditeur me montrait la définition de la fonction en question, ses propriétés, leur types, une description s’il y en a, etc…
J’avoue que j’ai limite voulu me cogner la tête contre un mur pour n’avoir pas vu ça plus tôt. Parce qu’après tout, c’est super pratique. Et ça me permet clairement d’avancer plus efficacement.