리팩토링: API 재사용성을 위한 코드 주석

객관식 영어 시험의 이미지, 나는 영어를 좋아했지만 모든 부분이 무엇인지 배우는 것을 좋아하지 않았기 때문에 내 점수는 도움이 필요했습니다. 내 강사는 종종 내 시험에 대해 언급했습니다.

우리가 기술을 따르고 있다면 솔루션에서 많은 기능을 생성하고 있습니다. 사실 너무 많습니다. Single Responsibility Principle을 따르기 때문에 각 기능이 실제로 수행하는 것과 관련하여 기억해야 할 내용이 너무 많습니다.

API

우리는 각 기능을 API로 취급해야 합니다. 즉, 이름과 기능으로 검색할 수 있어야 합니다.

다음과 같이 HTML 요소 선택에서 상태 변경을 허용해야 하는 주소 구성 요소를 가정합니다.

_{Note : We name all our functions with the prefix func. Its great for intellisense and for knowing where the code lives.}

onStateChange(state: NgModel) {
  if (state.viewModel) {
   // a reusable function in our API
   funcAddressResetProperties(this.address);

함수 이름이 각각의 기능을 알려주는 데 큰 도움이 되지만 더 많은 기능이 있음을 알 수 있습니다.



아, 아이디가 초기화 안된걸 몰랐네요. 하지만 지금은 그렇습니다. 이것을 배우는 시간은 간단한 호버 동작이었고 코드를 파헤칠 필요가 없었습니다.

위의 의견을 어떻게 얻었습니까?

/**Resets all but the ID property, 
// this is a design whereby new address 
// information overwrites old. */
export function 
funcAddressResetProperties(address: Address) 
{
   ... 
}

수백 가지 기능이 있는 경우 이것이 가장 좋은 방법입니다. 또한 나중에 게시될 최종 온라인 API 문서에도 기여합니다. API를 처음 사용하는 사람들은 시작하기 위해 온라인 설명서에 크게 의존합니다.

API로서의 JWP2020 코드 주석