Как вы решаете, какую документацию по функциям API читать и насколько серьезно?[закрыто]

Question

Предположим, вы пишете или поддерживаете фрагмент кода, использующий некоторый API, с которым вы не на 100% знакомы.

Как вы решаете, читать ли документацию по определенной цели вызова и сколько времени потратить на ее чтение?Как вы решили не читать это?

(Предположим, вы можете прочитать его, открыв документацию HTML, проверив исходный код или используя механизм наведения в IDE).

Answer 1

В идеале вам следует прочитать все об этом, но мы знаем, что это боль в...ты знаешь.Что я обычно делаю в таких случаях (а я делал это часто, пока работал фрилансером), так это взвешиваю некоторые факторы и в зависимости от результата читаю документацию.

Факторы, которые говорят мне, что мне не следует читать документацию:

• Что делает функция, легко догадаться по названию.
• Это не имеет отношения к коду, который я поддерживаю:например, вы проверяете, как какой-то код удаляет файлы, и у вас есть какая-то функция, которая, очевидно, выполняет какое-то обновление пользовательского интерфейса.Вас это пока не волнует.
• Если отладка:функция не изменила состояние программы способом, значимым для поставленной задачи.Как и раньше, вы не хотите узнавать, что делает SetOverlayIcon, если вы отлаживаете код удаления, потому что он умирает из-за ошибки файловой системы.
• API — это всего лишь частный случай API, который вы уже знаете, и вы можете догадаться, что это за особый случай и что делают специальные аргументы (если они есть).Например, предположим, что у вас есть WriteToFile(строковое имя файла) и WriteToFile(строковое имя файла, логическая перезапись).

Конечно, все зависит от контекста, поэтому даже из этих правил есть исключения.