예약어를 피하기위한 의도적 인 맞춤법 오류

나는 종종 더 나쁘게 예약어가 된 일반적인 단어의 의도적 인 철자가 틀린 코드를 본다 :

• klass나 clazz에 대한 클래스 :Class clazz = ThisClass.class
• kountSQL 에서 카운트 :count(*) AS kount

개인적으로 나는 이것이 가독성을 줄입니다. 내 자신의 연습에서 나는 더 좋은 이름이 사용되지 않았을 수 있습니다 너무 많은 경우를 발견하지 않았습니다 - itemClass나 recordTotal.

JavaDocs for Class 의 예제 는이를 매개 변수에 표시합니다.

 public <U> Class<? extends U> asSubclass(Class<U> clazz)

이것이 합리적인 사용 사례를 보여줍니까?

IMHO, 이것은 매우 나쁜 생각입니다. 예약어는 어떤 이유로 예약되어 있으며 이렇게하면 가독성이 떨어집니다.

나는 또한 두 번째 요점에 전적으로 동의합니다. 변수 이름을 class지정할 수는 있지만 변수 이름을 지정하는 것만 큼 tmp또는 이름을 지정하는 것만 큼 나쁩니다 a. 어떤 수업? 무엇의 수업? 이름은 설명 적이어야합니다.

파이썬 스타일 가이드 는이 문제를 구체적으로 설명하며 다음과 같이 제안합니다.

공개 속성 이름이 예약 키워드와 충돌하는 경우 속성 이름에 단일 밑줄을 추가하십시오. 약어 또는 손상된 철자보다 선호됩니다.

이것은 특정 언어의 의미와 충돌하지 않는다는 가정하에 꽤 좋은 규칙처럼 보입니다.

코드 냄새.

string stringVariable = "";

위의 코드는 의도 된 변수에 대해 아무 것도 알려주지 않습니다.

class Klass

같은 문제

string UserNameString = "bmackey"

위의 코드는 변수 이름에 키워드 문자열을 추가하지 않아도됩니다. 변수 이름으로 유형을 식별해야하는 경우 코드가 너무 깁니다. 밀도 리 팩터.

개인적으로, 이것이 귀하의 코드 스타일에 완벽하게 유효한 옵션이라고 생각합니다.

그것들은 예약어이므로 컴파일러는 언어 역학이나 변수를 의미하는지 여부를 결정할 필요가 없습니다. 이를 염두에두면 사람들이 예약어와 같은 변수가 필요할 것으로 기대 합니다.

JDK 1.6 R21에 번들로 제공되는 소스를 살펴보면 917 번의 "clazz"가 발견됩니다. 분명히, 그들은 그것이 수용 가능한 스타일이라고 생각했습니다.

당신의 팀은 그것에 대해 어떻게 생각합니까? 그것이 나쁘다고 생각하지만 팀의 다른 9 명이 좋다고 생각하면 총알을 물고 받아 들여야합니다. 옳고 그름에 대한 의사 소통이 있고보고있는 문제를보고있는 한 문제가되지 않습니다.

귀하의 팀이 코드 스타일에 대해 어떻게 생각하는지가 제 의견이나 다른 사람의 의견보다 중요 합니다. 이것과 다른 코드 스타일 결정에 적용됩니다.

예약어를 피하기위한 의도적 인 맞춤법 오류는 나쁜 생각입니다.

• 맞춤법이 틀린 철자와 올바른 철자를 구별하기 어렵 기 때문에 코드를 읽기가 어렵습니다.

• 맞춤법이 틀린 단어는 기억하기 어렵 기 때문에 일부 일관성없는 맞춤법 오류가 코드 내에서 경쟁하기 때문에 코드를 작성하기 어렵고 읽기가 더 어려워집니다.

• 예약어는 문제 자체가 아니라 문제를 해결하는 데 사용되는 언어를 나타냅니다. 변수 이름은 문제와 관련된 개념을 가리켜 야합니다.

그것은 대안을 설명하는 이름을 선택하는 것이 더 나은 또는 더 만족 대안이 존재하지 않는 경우에 자격 에서와 예약어 :

public static Method findBenchmarkMethod(BenchmarkRecord benchmark) {
    Class<?> benchmarkedClass = ClassUtils.loadClass(benchmark.generatedClass());
    return findBenchmarkMethod(benchmarkedClass, benchmark.generatedMethod());
}

Class clazz"나는 좋은 이름을 내놓으려고하지 않았다"는 냄새가 난다. 변수는 항상 무언가를 나타내며 좋은 이름은 그것을 나타냅니다. clazz예를 들어 어떤 상황에서도 가능한 최고의 이름 이라고 생각하지 않습니다 . 클래스-> class_reference에 대한 참조입니까, 클래스 객체의 복사본입니다-> class_copy 등. 아마도 "class"를 삭제하고 설명적인 단어를 사용하십시오.

java.lang.SecurityManager.checkMemberAccess(Class<?> clazz, int which)
Parameters
    clazz -- the class that reflection is to be performed on.

여기서 clazz는 검사를 수행 할 대상 클래스이므로

checkMemberAccess(Class<?> target, int which)

clazz보다 매개 변수가 사용되는 것을 훨씬 더 잘 설명합니다.

변수에 예약 된 이름을 사용하면 이름이 잘못 지정된 변수입니다. 강의실 소프트웨어 용 클래스와 같이 합법적 인 이름 인 경우에도 마찬가지입니다.

잘못 명명 된 변수는 잘못 생각했거나 우연한 코드의 표시입니다. 유지 관리하는 소프트웨어에 다른 문제가있을 경우주의하십시오.

신중하고 일관되게 사용한다면 의도적 인 철자 나 약어가 좋은 생각이라고 생각 합니다 .

Java에서 고려하십시오.

class X { public X() { } }
X x = new X();
x.getClass;  // Wha?  How does "get" help anything?
x.class;     // Best, but requires more lexer/parser work
x.klass;     // At least as good as getClass
x.clazz;     // Same

맞춤법이 틀린 곳은 예약어가 작업에 가장 적합한 단어입니다. 유혹을받을 수있는 맞춤법 오류를 사용 하지 않는 두 곳 이 있습니다.

1. 좋은 이름을 생각하고 싶지 않다
2. 당신은 더미 변수를 원하고 설명적인 이름이 필요하지 않습니다.

첫 번째 경우, 게으름이 품질 코드를 생성하기위한 좋은 정책이 아니라는 것은 명백합니다. 두 번째 경우에는 매우 짧은 변수를 선택하십시오. 그것이 바로 수학자들이 항상하는 일이며 프로그래머는 색인을 위해하는 일입니다. 실제로 더미 변수 일 경우 인덱스에 대해이 작업을 제한 할 이유가 없습니다.

boolean isMyName(String testName) { return myName.equals(testName); }
boolean isMyName(String s) { return myName.equals(s); }

Date nextMeeting(Klass klass) { return /* something */ }
Date nextMeeting(Klass k) { return /* something */ }

메소드 나 코드 구조에 무엇이 있어야하는지 알려 주면 변수 이름이 짧은 것을 잃지 않습니다.

클래스 Class klass의 인스턴스로 실제로 작업하는 리플렉션 을 할 때 합법적으로 사용하는 것을 보았습니다 Class.

나는 종종 더 나쁘게 예약어가 된 일반적인 단어의 의도적 인 철자가 틀린 코드를 본다 :

클래스의 klass 또는 clazz : 클래스 clazz = ThisClass.class

SQL에서 카운트를위한 kount : count (*) AS kount

개인적으로 나는 이것이 가독성을 줄입니다. 내 자신의 연습에서 itemClass 또는 recordTotal과 같이 더 나은 이름을 사용할 수없는 경우가 너무 많지 않았습니다.

그러나 내가 도울 수는 없지만 내가 유일한 사람인지 궁금해하는 것은 흔한 일입니까? 이 연습에 대해 존경받는 프로그래머의 조언이나 더 나은 인용 된 제안이 있습니까?

지역 변수와 형식 인수에 대해서는 중요하지 않습니다.

의도적으로 오도하거나 성가신 산만하지 않는 한 어떤 이름도 좋습니다. 귀하의 예에서 :

public static Method findBenchmarkMethod(BenchmarkRecord benchmark) {
    Class<?> clazz = ClassUtils.loadClass(benchmark.generatedClass());
    return findBenchmarkMethod(clazz, benchmark.generatedMethod());
}

단일 로컬 변수가 "clazz"또는 "klass"또는 "cls"인지 또는 단순히 "c"인지는 중요하지 않습니다. 아마도 표현식을 인라인 할 것입니다.

return findBenchmarkMethod(ClassUtils.loadClass(benchmark.generatedClass()),
                           benchmark.generatedMethod());

변수 이름의 길이는 변수의 범위와 관련이 있어야합니다. 짧은 방법으로 지역 변수의 경우 (그리고 모두 짧아야 함) 매우 짧은 이름이 좋습니다.

맞춤법 오류가 항상 나쁜 생각이라고 생각합니다. 독자에게는 좋지 않습니다. 나는 하나의 단어를 볼 때 내가 뭔가를 놓쳤는 지 궁금 할 것이다 klass. (그들이 class해적을 의미 했습니까 , 아니면 해적을 의미 했습니까 ?) 적어도 나에게, 내가 인식하는 모든 철자가 틀린 것입니다.

예약어가 실제로 변수에 대해 알려진 유일한 중요한 경우는 다음과 같은 대안을 사용합니다.

• 함수 인수 인 경우 aClass대신을 사용하십시오 class.

• 로컬 또는 멤버 변수 인 경우 myClass대신를 사용하십시오 class.

• 접근자인 경우 getClass()대신을 사용하십시오 class().

물론, 추가 된 접두사는 무의미하며, 따라서 최후의 수단으로 만 사용해야합니다. 그러나 적어도 그것은 독자의 정신적 파서를 방해하지 않으며 예약어를 피하는 안전한 방법입니다.

창의적인 맞춤법의 이점 중 하나는 더 나은 검색 기능입니다. 나는 너무 자주 당신이 잘못된 것들과 1000 개를 찾을 수있는 일반적인 단어보다 독특한 것들에 대한 완전한 코드 검색을 수행하는 것이 훨씬 쉽다고 생각합니다. 예를 들어, 나는 kzpg.com을 소유했습니다. 구글은 지금 당신은 몇 안타 만 볼 수 있습니다. 독특하고 따라서 찾을 수 있습니다.

그러나 어느 정도는이 질문이 물질 이상의 의견이라고 생각합니다. 나는 개인적으로 단어와 그 많은 단어에 관한 Forth에서 자랐습니다. 한 사람은 손가락을 구하기 위해 창의력을 발휘하는 법을 배웠습니다. 결국 나는 약 640,000 문자를 내 소스 기반으로 사용했습니다. 따라서 단어를 짧게 유지하는 것이 일을 끝내는 데 중요했습니다.