단어가 명사 및 동사 일 때 변수 이름을 지정하는 방법

다음과 같은 일반적인 지침으로 코너 케이스 문제가 발생했습니다.

• 변수의 명사
• 함수 동사

특히, 단어가 모호한 경우가 있습니다-동사 또는 명사 일 수 있습니다 . 그리고 어떤 경우에는 응용 프로그램을 논의 할 때 동일한 문장에서 두 가지 방식 으로 사용됩니다 .

나는 몇 달 후 코드 섹션으로 돌아갈 때 나 자신뿐만 아니라 미래 개발자도 프로그램을 계속 읽을 수 있도록 노력하고있다.

예제 중 하나는입니다 battery. A는 batteryA가 들어 charge당신도 할 수있는 charge()배터리.

나는 모두를 가지고 있다고 생각 Battery.Charge하고하는 것은 Battery.Charge(value)미래의 개발자들에게 혼동을 줄 수 있습니다.

현재 해결 방법은 해당 사례 중 하나 또는 둘 다에 대해 다른 단어를 선택하는 것입니다 (변수 및 함수). 그 접근법에 대한 나의 문제는 Battery객체의 변수와 함수 charge가와 관련된 디자인 토론과 일치하지 않는다는 것 Battery입니다.

내 질문은 명명 규칙 에서이 충돌을 처리하는 또 다른 더 좋은 방법이 있는지 여부입니다.

주제에 대한 추가 자료. 아무도 내 질문의 특정 문제를 해결하지 못했습니다.

• 의미있는 간결한 방법 명명 지침
• 변수의 명명 규칙
• https://softwareengineering.stackexchange.com/questions/14169/what-naming-guidelines-do-you-follow 에서 선택한 답변

비슷한 상황에서 나는 동의어를 찾으려고 노력합니다. 이 경우 동사에 "충전"을 사용합니다. "재"는 약간 중복되지만 그 의미는 분명합니다. 배터리의 남은 충전량에 간단한 "충전"을 사용하는 것은 물리적 인 단위를 지정하지 않기 때문에 모호합니다. "availableAmpHours", "hoursUntilRecharge"또는 이와 유사한 것을 선호합니다. 단위는 어플리케이션에 편리한 것에 달려 있습니다.

개인적으로 선호하는 것은 상태를 바꾸는 함수에 대해서만 동사를 사용하는 것입니다. 비 돌연변이 함수에는 명사를 사용합니다. 나는 그것이 당신의 관점에 달려 있다고 생각합니다. 기계 수준에서는 비 돌연변이 기능이 작동하지만 모델 수준에서는 그렇지 않습니다.

이 문제를 해결하는 것만으로도 모호한 이름 지정 인스턴스에 대한 해결책은 배터리에서 해당 기능을 완전히 제거하는 것입니다. 나는 자체 충전 배터리를 본 적이 없으며 BatteryCharger 클래스를 갖는 것이 더 합리적입니다. 이렇게하면 문제가 더 분리되고 조치가보다 명확 해집니다.

battery.Charge(50) vs batteryCharger.Charge(battery, 50)

나에게 두 번째 형태는 훨씬 더 이해하기 쉽고 모든 배터리 클래스에 뿌려주는 대신 모든 "충전"코드를 한 곳에 보관합니다.

이중 의미를 피하십시오

의도적으로 하나 이상의 의미가있는 단어를 선택했으며 첫 번째 결정은 문제입니다. 프로그래머에게는 문제가되는 수많은 단어가 있습니다. 또 다른 예는입니다 phone. 당신은 할 수있는 phone사람을, 또는 당신은있을 수 phone주머니에.

게터와 세터 사용

대부분의 객체에 대한 표준 명명은 속성에 대한 getter / settings 메소드입니다.

Battery.Charge            // would be a property
Battery.setCharge(value)  // would set the property
Battery.getCharge()       // would get the property

속성은 명사가 아닌 국가입니다

객체 속성을 명사로 분류하여 실수했다고 생각하고 변수도 상태를 생각할 수 있습니다. 그것들은 그들의 존재 범위와 관련된 상태입니다.

그들이 명사로 보유하고있는 가치를 설명 할 수는 있지만, 그것이 모든 경우에 해당되는지는 확실하지 않습니다.

OOP 용어에서 객체 속성은 해당 객체의 상태를 설명합니다. 귀하의 경우에는 Battery객체이며 Charge상태입니다. 그래서 그것은 객체의 속성이 될 것입니다, 그러나 이것은 그것이 어떻게 사용되는지에 달려 있습니다.

Charge배터리 를 사용할 수 있어야하고 전류 Charge가 무엇인지 알면 문제가있는 것입니다.

범위를 사용하여 컨텍스트 적용

문맥은 당신이 전달하고자하는 단어 나 방법의 의미를 명확히 할 것입니다. 범위는 객체 외부에서 속성 / 방법의 접근성을 설정합니다.

Batter._charge            // a hidden private property
Battery.setCharge(value)  // would set the private property
Battery.getCharge()       // would get the private property
Battery.Charge()          // would perform the Charge action

방법은 동사입니다

객체의 방법을 동사로 설명 할 수 있지만 동작이라는 단어가 더 적합합니다. OOP 용어에서는 객체의 방법을 사용하여 객체에 대한 작업을 수행합니다. 객체 외부에서 객체의 속성을 수정하는 것은 좋지 않습니다. 상태를 변경시키는 데 필요한 조치를 수행하는 메소드를 호출하는 것이 좋습니다.

이 단어 Charge는 동사이지만 명사이기도합니다. 동작의 메소드를 호출하는데 사용될 때 동사가 사용되고 있다는 것이 분명해진다 Battery.Charge(....).

그러나 상황은 매우 중요합니다. 단어 Charge()는 동사이지만 의미가 없습니다 startCharging().

유효한 방법을 Battery포함 할 수있다 Charging, Discharging, setCharge, getCharge, hasCharge, Discharge와 Charged.

간단한 한 단어 방법은 종종 명시 적으로 명확하게 자신의 행동을 언급하지 않지만, 같은 몇 가지 경우가 있습니다 open와 close약간의 설명이 필요한 곳은.

따라서 이러한 유형의 속성 / 방법의 이름을 지정하는 방법에 대한 정답은 없습니다. 혼동이 없도록 위의 기술을 현명하게 사용해야합니다.

동사를 동사 나 명사로 만들 동사 앞에 붙입니다.

Battery.doCharge()

Battery.getCharge()

동사의 경우에는 Charge괜찮습니다. 명사 사건의 경우 getCurrentChargeLevel효과가 있습니까?

대부분의 경우 도움 동사, 부사 또는 형용사를 추가하는 것은 그것들을 구별하기에 충분하며 실제로 이해하는 데 도움이 될 수 있습니다. 배터리에 충전 및 충전 ()을 사용하면 DeltaCharge ()는 충전 또는 방전을 처리 할 수있는 기능임을 나타낼 수 있습니다.

델타 (변경이 있지만 모호한 경우)는 상태 변경을 처리하기 위해 항상 (다른 동사가 반 명백한 경우에도) 사용하고 다른 사람들에게 권장하는 수정 자입니다.

구조에 헝가리어 표기법. 당신은 할 수 있습니다 intCharge및 fcnCharge(value)따라서 혼란을 피하고 세 글자가 잘 작동 할 때 미친 긴 이름을 추가하지.

또는 동일한 이름을 사용하여 IDE에서 처리하도록 할 수 있습니다. 더 길거나 다른 이름을 만드는 것은 결국 장기적으로 혼란 스러울 수 있습니다.