¿Cómo decide qué documentación de la función API leer y con qué seriedad? [cerrado]

Question

Supongamos que está escribiendo o manteniendo un fragmento de código que utiliza alguna API con la que no está 100% familiarizado.

¿Cómo decide si leer la documentación de un determinado objetivo de llamada y cuánto tiempo debe dedicar a leerlo? ¿Cómo decides no leerlo?

(Supongamos que puede leerlo abriendo la documentación HTML, inspeccionando el código fuente o utilizando el mecanismo de desplazamiento en el IDE).

Answer 1

Idealmente, debería leer todo , pero sabemos que es un dolor en el ... ya sabes. Lo que normalmente hago en esos casos (y lo hice mucho mientras trabajaba como freelance) es ponderar algunos factores y, dependiendo del resultado, leo los documentos.

Factores que me dicen que no debería leer los documentos:

• Lo que hace la función es fácil de adivinar por el nombre.
• No es relevante para el código que estoy manteniendo: por ejemplo, está verificando cómo parte del código elimina los archivos y tiene alguna función que obviamente hace alguna actualización de la interfaz de usuario. No te importa eso por ahora.
• Si se está depurando: la función no cambió el estado del programa de manera significativa para la tarea en cuestión. Como antes, no quiere saber qué hace SetOverlayIcon, si está depurando el código de eliminación porque está muriendo por un error del sistema de archivos.
• La API es solo un caso especial de una API que ya conoce y puede adivinar qué es el caso especial y qué hacen los argumentos especiales (si los hay). Por ejemplo, digamos que tiene WriteToFile (nombre de archivo de cadena) y WriteToFile (nombre de archivo de cadena, sobrescritura booleana).

Por supuesto, todo depende del contexto, por lo que incluso esas reglas tienen excepciones.