읽을 API 기능 문서와 얼마나 심각한지를 어떻게 결정합니까? [닫은

Question

100% 익숙하지 않은 일부 API를 사용하는 코드를 작성하거나 유지하고 있다고 가정 해보십시오.

특정 통화 대상의 문서를 읽을 것인지 여부와 그것을 읽는 데 얼마나 많은 시간을할지 결정합니까? 그것을 읽지 않기로 결정합니까?

(HTML 문서를 열거나 소스 코드를 검사하거나 IDE에서 호버 메커니즘을 사용하여 읽을 수 있다고 가정 해 봅시다.

Answer 1

이상적으로 읽어야합니다 모두 그것의 그러나 우리는 그것이 ... 당신은 알고 있습니다. 내가 그 경우에 일반적으로하는 일 (그리고 프리랜서로 일하는 동안 많은 일을했습니다)은 몇 가지 요인이며 결과에 따라 문서를 읽습니다.

문서를 읽어서는 안된다고 말하는 요소 :

• 기능이하는 일은 이름에서 쉽게 추측하기 쉽습니다.
• 예를 들어, 일부 코드가 파일을 삭제하는 방법을 확인하고 있으며 일부 UI 업데이트를 수행하는 기능이 있습니다. 당신은 지금 그것에 대해 신경 쓰지 않습니다.
• 디버깅 인 경우 : 기능이 현재 작업에 의미있는 방식으로 프로그램 상태를 변경하지 않았습니다. 이전과 마찬가지로 파일 시스템 오류로 사망하기 때문에 삭제 코드를 디버깅하는 경우 SetoverLayicon이하는 일을 배우고 싶지 않습니다.
• API는 이미 알고있는 API의 특별한 경우 일 뿐이며 특별한 경우가 무엇인지, 그리고 특별한 주장 (있는 경우)이 무엇을하는지 추측 할 수 있습니다. 예를 들어, writeTofile (String filename) 및 WriteTofile (String Filename, Boolean Overwrite)이 있다고 가정 해 봅시다.

물론 모든 것이 맥락에 달려 있으므로 이러한 규칙조차 예외가 있습니다.