Como você decide qual documentações função API para ler e como a sério? [fechadas]

Question

Suponha que você está escrevendo ou manter um pedaço de código que usa alguns API que você não está 100% familiarizado.

Como você decidir se quer ler a documentação de um determinado alvo chamada, e quanto tempo para gastar lê-lo? Como você decidir não para lê-lo?

(Vamos supor que você pode lê-lo, abrindo a documentação HTML, inspecionando o código-fonte, ou usando o mecanismo de foco no IDE).

Answer 1

Idealmente, você deve ler todas dela, mas sabemos que é uma dor no ... você sabe. O que eu faço normalmente nesses casos (e eu fiz isso muito enquanto eu trabalhava como freelancer) é o peso de alguns fatores e, dependendo do resultado, eu li os docs.

Os fatores que me dizem que eu não deveria ler os docs:

• O que a função faz é fácil de adivinhar a partir do nome.
• Não é relevante para o código que estou mantendo: por exemplo, você está verificando como alguns código exclui arquivos, e você tem alguma função que, obviamente, faz alguma atualização UI. Você não se preocupam com isso por enquanto.
• Se a depuração: a função de não alterar o estado do programa de uma forma significativa para a tarefa em mãos. Como antes, você não quer saber o que SetOverlayIcon faz, se você está depurando o código supressão porque está morrendo com um erro de sistema de arquivos.
• A API é apenas um caso especial de uma API que você já sabe e você pode adivinhar o que o caso especial é, eo que os argumentos especiais (se houver) fazer. Por exemplo, digamos que você tem WriteToFile (string filename) e WriteToFile (string arquivo, boolean substituir).

Claro, tudo depende do contexto, por isso mesmo essas regras têm exceções.