Skip to Content
Tidy First?
book

Tidy First?

by Kent Beck
April 2025
Intermediate to advanced
124 pages
2h 8m
Italian
O'Reilly Media, Inc.
Content preview from Tidy First?

Capitolo 14. Spiegare i commenti

Questo lavoro è stato tradotto utilizzando l'AI. Siamo lieti di ricevere il tuo feedback e i tuoi commenti: translation-feedback@oreilly.com

Hai presente quel momento in cui, leggendo del codice, dici: "Oh,ecco cosa sta succedendo!". Quello è un momento prezioso. Registralo.

Scrivi solo ciò che non era evidente dal codice. Mettiti nei panni del futuro lettore o di te stesso 15 minuti fa. Cosa avresti voluto sapere? Potresti scrivere una nota del tipo: "Quanto segue è complicato dalla necessità di ridurre il più possibile il numero di chiamate alla rete".

Scrivi a qualcuno di specifico, anche se non è molto simile a te. Sei l'unico biologo del tuo team di informatici? Allora faresti meglio a spiegare qualsiasi contesto biologico nel codice, anche se a te sembra ovvio. Il punto è pensare dal punto di vista di qualcun altro e cercare di rispondere in anticipo alle possibili domande.

Se trovi un file con nessun commento di intestazione, considera la possibilità di aggiungere un'intestazione che spieghi ai potenziali lettori perché potrebbero trovare utile la lettura di questo file. (Grazie, AllanMertner).

Il momento in cui si scopre un difetto è un buon momento per commentare. Ad esempio, // Be sure to change ../foo if you add another case. Non è ideale avere questo accoppiamento nel codice. Alla fine dovrai imparare a eliminarlo, ma nel frattempo è molto meglio aggiungere un commento che indichi il problema di accoppiamento, piuttosto che lasciarlo ...

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

AirBnbBlueOriginElectronic ArtsHomeDepotNasdaqRakutenTata Consultancy Services

QuotationMarkO’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.
Julian F.
Head of Cybersecurity
QuotationMarkI wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.
Addison B.
Field Engineer
QuotationMarkI’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.
Amir M.
Data Platform Tech Lead
QuotationMarkI'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Mark W.
Embedded Software Engineer

You might also like

Tidy First?

Tidy First?

Kent Beck
System Design Masterclass

System Design Masterclass

Rohit Jain Sweet Codey, Suresh Gandhi, Shubham Chandak

Publisher Resources

ISBN: 9798341643932