[naming-conventions] 다른 사람이 프로그래밍에서 가장 어려운 부분 중 하나 인 명명 클래스와 메소드를 찾으십니까? [닫은]

적절한 명명 규칙은 주어진 변수, 클래스, 메소드 또는 함수에 사용할 수있는 이름의 수를 최소화해야합니다. 가능한 이름이 하나만 있으면 이름을 기억하는 데 어려움이 없습니다.

함수와 싱글턴 클래스의 경우 기본 함수가 한 종류의 것을 다른 종류의 것으로 변환하는 것인지 확인하기 위해 함수를 면밀히 조사합니다 . 나는 그 용어를 매우 느슨하게 사용하고 있지만, 당신이 작성하는 수많은 함수는 본질적으로 어떤 형태로 무언가를 취하고 다른 형태로 무언가를 생산한다는 것을 알게 될 것입니다.

귀하의 경우 클래스 가 Url을 문서로 변환 하는 것처럼 들립니다 . 그런 식으로 생각하는 것은 조금 이상하지만 완벽하게 맞습니다.이 패턴을 찾기 시작하면 어디서나 볼 수 있습니다.

이 패턴을 찾으면 항상 함수 이름을 x Fromy로 지정 합니다.

함수 가 URL을 문서로 변환 하므로 이름을 지정합니다.

DocumentFromUrl

이 패턴은 매우 일반적입니다. 예를 들면 다음과 같습니다.

atoi -> IntFromString
GetWindowWidth -> WidthInPixelsFromHwnd // or DxFromWnd if you like Hungarian
CreateProcess -> ProcessFromCommandLine

당신이 UrlToDocument그 순서에 더 편한 경우 에도 사용할 수 있습니다 . 당신이 말하는 여부 의 X From, Y 또는 y를 Tox는 아마 취향의 문제이지만, 내가 선호 From하는 방법은 함수 이름의 시작은 이미 당신을 알려주기 때문에 순서가 반환 무엇을 입력합니다.

하나의 규칙을 선택하고 준수하십시오. x Fromy 함수 에서 클래스 이름과 동일한 이름을 사용하는 데주의를 기울이면 사용한 이름을 기억하기가 훨씬 쉽습니다. 물론이 패턴은 모든 것이 작동하지는 않지만 “기능적”이라고 생각할 수있는 코드를 작성하는 경우에는 작동합니다.

답변

function programming_job(){
    while (i make classes){
         Give each class a name quickly; always fairly long and descriptive.
         Implement and test each class to see what they really are.
         while (not satisfied){
            Re-visit each class and make small adjustments
         }
    }
}

while(true){
      if (any code smells bad){
           rework, rename until at least somewhat better
      }
}