프로그래머 마다 파악 해 야 할 20 개의 코드 이름 팁
4871 단어 코드 이름
1.의 도 를 표현 할 수 있 는 이름 사용
이름 은 우리 에 게 그것 이 무엇 을 해 야 하 는 지,왜 존재 하 는 지,그리고 어떻게 일 하 는 지 알려 줄 수 있어 야 한다.의 도 를 표현 할 수 있 는 이름 을 선택 하면 코드 를 이해 하 는 데 유리 할 것 이다.
int d; // elapsed time in days
int elapsedTimeInDays;
int daysSinceCreation;
int daysSinceModification;
int fileAgeInDays;2.이름 을 고 르 는 데 시간 이 걸 리 는 것 을 두려워 하지 마 세 요.
너 는 그 의 미 를 묘사 할 수 있 을 때 까지 몇 가지 다른 이름 을 더 시험 해 봐 야 한다.절대 이 위 에서 시간 을 쓰 는 것 을 두려워 하지 마라.앞으로 당신 의 코드 를 읽 는 사람(당신 자신 포함)은 이 로 인해 이익 을 얻 을 것 입 니 다.그 밖 에 묘 사적인 명칭 은 심지어 당신 이 마음속 으로 모듈 의 설 계 를 정리 하 는 데 도움 이 될 수도 있다.좋 은 이름 을 짓 는 데 는 시간 이 걸 리 지만 장기 적 으로 는 득 보다 실 이 많다.
3.이름 재 구성
뒤의 개발 과정 에서 더 좋 은 이름 이 떠 올 랐 다 면 주저 하지 말고 바로 고 쳐 라.현재 의 IDE 는 이름 재 구성 을 매우 쉽게 한다.
4.이름 에 방해 단어 가 나 오지 않도록 한다.
예 를 들 어 Manager,Processor,Data,Info 와'나 는 이것 을 뭐라고 부 르 는 지 모른다'는 동의어 가 모두 방해 단어 이다.위 에 있 는 방해 단어 들 을 사용 해 야 한다 면 이름 이 너무 번 거 로 울 수도 있다.
5.이름 붙 이기 어 려 운 클래스/기능 조심
이름 을 짓 기 어 려 운 클래스 나 함수 가 코드 냄새 일 가능성 이 높다.이 설명:
코드 를 너무 많이 만 들 었 어 요.
코드 가 아직 부족 합 니 다.
너 는 이 문제 에 대해 아직 철저하게 이해 하지 못 했 으 니,먼저 더 많은 정 보 를 얻어 야 한다.
6.유형 명
클래스 는 Customer,WikiPage,Account,Address Parser 와 같은 명사 나 명사 어구 이름 이 있어 야 합 니 다.상속 성 부 류 는 짧 고 충격 적 인 이름 을 줘 야 한다.하위 클래스 의 이름 은 길 어야 합 니 다.형용 사 를 통 해 아버지 와 다른 점 을 묘사 해 야 합 니 다.예 를 들 어 SavingsAccount 은 Account 에서 파생 됩 니 다.
7.변수 이름
변수 이름 도 명사 여야 한다.그것들 은 대부분 그 가 가리 키 는 종류 에서 파생 된 것 이다.불 변 수 는 isEmpty 와 isTerminated 와 같은 서술 어 형식 으로 써 야 if 문 구 를 이해 할 수 있 습 니 다.
8.방법 명
방법 명 은 postPayment(),deletePage(),save()와 같은 동사 나 동사 어구 여야 합 니 다.접근 기와 조정 기 는 각각 접두사 get 과 set 를 사용 해 야 합 니 다.불 값 을 되 돌려 주 는 방법 은 isPostable()과 같은 접두사'is'가 있어 야 if 구문 에서 쉽게 이해 할 수 있 습 니 다.
9.범위 크기 와 변수 이름 의 길이
변수 이름 의 길 이 는 범위 크기 와 일치 해 야 합 니 다.변수의 범위 가 매우 짧다 면 변수 이름 의 길이 도 매우 짧 아야 한다.반대로 변수 이름 은 좀 길 고 서술 적 이 어야 한다.
10.범위 크기 와 방법/클래스 이름 의 길이
방법 과 유형 이름 의 길 이 는 그 범위 와 반비례 해 야 한다.공공 방법 에 대해 서 는 짧 은 이름 이 좋 을 것 이다.여러 번 호출 되 기 때문이다.개인 적 인 방법 은 클래스 범위 내 에서 만 호출 되 고 긴 이름 은 오히려 문서 로 사용 할 수 있 습 니 다.이 규칙 의 예 외 는 파생 류 의 이름 이다.클래스 가 파생 될 수록 기본 클래스 앞 에 붙 인 형용사 가 많 고 이름 도 길다.
11.한 개념 한 단어
어떤 추상 적 인 개념 을 위해 단 어 를 선택 한 후에 변 하지 마라.예 를 들 어 같은 종류의 등가 방법 으로 get(),fetch()와 retrieve()는 사람 을 헷 갈 리 게 할 수 있다.일치 하 는 어 휘 를 유지 하 는 것 은 프로그래머 가 코드 를 제어 하 는 중요 한 도구 이다.
12.같은 단 어 를 두 개의 다른 개념 에 사용 하지 마라.
만약 당신 이 11 시-하나의 개념,하나의 단어의 원칙 을 따른다 면,같은 방법 명 을 가 진 많은 종 류 를 피 할 수 있 을 것 이다.매개 변수 목록 과 각종 방법의 반환 값 이 의미 적 으로 등가 라면 문제 가 없다.같은 단 어 를 두 개의 다른 개념 에 사용 할 때 만 문제 가 생 긴 다.
예 를 들 어,우 리 는 여러 클래스 에서 add()방법 을 사용 하여 기 존의 값 두 개 를 추가 하거나 연결 하여 새로운 값 을 만 들 수 있 습 니 다.만약 우리 가 나중에 클래스 에 하나의 add 방법 을 도입 하여 집합 에 파 라 메 터 를 추가 해 야 한다 면 이것 은 의미 가 다 르 기 때문에 문 제 를 일 으 킬 것 이다.이런 새로운 방법 은 insert()로 바 꾸 는 것 이 가장 좋다.
13.솔 루 션 영역 이름 사용
우리 가 작성 한 코드 는 앞으로 다른 프로그래머 가 읽 을 수 있 기 때문에 우 리 는 일부 기술 용 어 를 사용 하여 코드 이름 을 짓 는 것 이 큰 도움 이 될 것 입 니 다.예 를 들 어 현지에서 알고리즘 이름,디자인 모델 이름 과 수학 용 어 를 사용 하면 다른 프로그래머 들 이 프로그램 을 쉽게 이해 하고 공감 대 를 형성 할 수 있다.
14.문제 영역 이름 사용
이해 하기 쉬 운 기술 용 어 를 찾 지 못 하면 문제 분야 에서 적절 한 코드 이름 을 찾 을 수도 있다.앞으로 코드 를 읽 을 프로그래머 가 코드 의 미 를 확인 하지 못 할 때,이것 은 그들 에 게 문제 의 단 서 를 제공 할 것 이다.
15.의미 있 는 언어 환경 추가
대부분의 이름 은 그 자체 가 의미 가 없 으 며 언어 환경(클래스/함수/네 임 스페이스)에 넣 어야 코드 를 읽 는 사람 이 무엇 을 가리 키 는 지 이해 할 수 있다.어떤 경우 에는 언어 환경 을 보충 하기 위해 접두사 이름 이 필요 할 수 있 습 니 다.예 를 들 어 주 소 를 표시 하 는 변수 가 있다 고 가정 합 니 다.firstName,lastName,street,house Number,city,state 와 zip.만약 state 라 는 변수 만 본다 면,우 리 는 그것 이 무슨 뜻 을 가리 키 는 지 추측 하기 어 려 울 것 이다.비교적 좋 은 해결 방법 은 바로 이 변 수 를 Address 류 에 봉인 하 는 것 이다.
16.이유 없 는 언어 환경 을 추가 하지 마라
뜻 이 명확 하 다 면 짧 은 이름 이 긴 것 보다 좋 으 므 로 쓸데없는 언어 환경 을 추가 하지 마 세 요.이름 앞 에 클래스/가방/네 임 스페이스 에서 추정 할 수 있 는 불필요 한 정 보 를 붙 여 서 는 안 됩 니 다.
17.인 코딩 피하 기
현재 IDE 의 강 함 을 감안 하여 저 희 는 인 코딩 형식 과 범위 정 보 를 변수 이름과 유형 에 포함 시 킬 필요 가 없습니다.코드 를 사용 하 는 사용 자 는 클래스 가 인터페이스 로 전달 되 고 있 는 지 알 필요 가 없 기 때문에 인터페이스 에 I 를 추가 할 필요 가 없습니다.따라서 인 코딩 을 꼭 사용 해 야 한다 면 인터페이스 가 아 닌 인 코딩 을 하 는 것 이 좋다.
18.잘못된 정보 피하 기
코드 를 읽 는 사람 을 오도 할 수 있 기 때문에 잘못된 정 보 를 주지 마 세 요.실제 지원 배열 의 변 수 를 accontList 라 고 부 르 면 잘못된 결론 을 내리 기 쉽다.
19.읽 을 수 없 는 이름 사용
프로 그래 밍 은 읽 을 수 없 는 이름 을 사용 하 는 것 은 우리 의 토론 을 방해 할 뿐이다.
20.검색 하기 쉬 운 이름 사용 하기
짧 고 통용 되 는 이름 을 사용 하면 코드 라 이브 러 리 에서 사물 을 검색 하 는 데 방해 가 될 수 있다.이것 은 우리 가 코드 를 조작 하고 재 구성 하 는 데 매우 영향 을 미친다.
마지막 으로 다른 의견 이 있 으 시 면 아 낌 없 는 가르침 을 환영 합 니 다.
번역문 링크:http://www.codeceo.com/article/20-naming-tips-programmer-know.html
영어 원문:20 Tips for Better Naming
야드 농 망 C 소 봉
좋은 웹페이지 즐겨찾기
