Come decidete quali documentazioni delle funzioni API leggere e quanto seriamente? [chiuso]

Question

Supponiamo che tu stia scrivendo o gestendo un pezzo di codice che utilizza alcune API che non conosci al 100%.

Come decidi se leggere la documentazione di un determinato target di chiamata e quanto tempo dedicare a leggerlo? Come decidi di non leggerlo?

(Supponiamo che tu possa leggerlo aprendo la documentazione HTML, ispezionando il codice sorgente o usando il meccanismo hover nell'IDE).

Answer 1

Idealmente dovresti leggere tutto , ma sappiamo che è un dolore nel ... sai. Quello che faccio normalmente in quei casi (e l'ho fatto molto mentre lavoravo come libero professionista) è ponderare alcuni fattori e, a seconda del risultato, leggo i documenti.

Fattori che mi dicono che non dovrei leggere i documenti:

• Che cosa fa la funzione è facile indovinare dal nome.
• Non è rilevante per il codice che sto conservando: ad esempio, stai controllando come del codice elimina i file e hai alcune funzioni che ovviamente eseguono un aggiornamento dell'interfaccia utente. Per ora non ti interessa.
• Se debug: la funzione non ha modificato lo stato del programma in modo significativo per l'attività in corso. Come prima, non vuoi sapere cosa fa SetOverlayIcon, se stai eseguendo il debug del codice di eliminazione perché sta morendo con un errore del file system.
• L'API è solo un caso speciale di un'API che già conosci e puoi indovinare qual è il caso speciale e cosa fanno gli argomenti speciali (se presenti). Ad esempio, supponiamo di avere WriteToFile (nome file stringa) e WriteToFile (nome file stringa, sovrascrittura booleana).

Naturalmente, tutto dipende dal contesto, quindi anche quelle regole hanno delle eccezioni.