고품질 코드 작성 - 이름 지정부터 시작

프로그래밍 초보자는 항상 프로그래밍 언어, 구문, 기술 및 프로그래밍 도구 사용을 배우는 데 많은 시간을 보냅니다. 그들은 이러한 기술을 익히면 좋은 프로그래머가 될 수 있다고 믿습니다. 그러나 컴퓨터 프로그래밍의 목적은 이러한 기술과 도구를 익히는 것이 아니라 특정 분야의 특정 문제에 대한 솔루션을 만드는 것이며 프로그래머는 이를 달성하기 위해 서로 협력합니다. 그러므로 자신의 생각을 코드로 정확하게 표현하여 다른 사람이 코드를 통해 자신의 의도를 이해할 수 있도록 하는 것이 매우 중요합니다.

먼저 프로그래밍 마스터 Robert C. Martin의 명작 "Clean Code"의 한 문장을 살펴보겠습니다.

코멘트의 목적은 코드 자체의 표현력 부족을 보완하는 것입니다.

이 문장은 코드에 주석이 필요한 것처럼 간단히 이해하면 코드가 잘못 작성되었을 가능성이 높습니다. 마찬가지로, 주석 없이 문제나 알고리즘에 대한 생각을 코드로 완전히 표현할 수 없다면 이는 실패의 신호입니다. 궁극적으로 이는 코드에 표시되지 않는 생각의 일부를 명확하게 하기 위해 주석을 사용해야 함을 의미합니다. 좋은 코드는 코멘트가 없어도 누구나 이해할 수 있습니다. 좋은 코딩 스타일에는 코드의 문제를 이해하는 데 도움이 되는 모든 정보가 포함되어 있습니다.

프로그래밍 이론에는 "자기 기술적 소스 코드"라는 개념이 있습니다. 코드 조각의 경우 일반적인 자체 설명 메커니즘은 변수, 메서드 및 개체에 대해 엄격하지 않게 정의된 일부 명명 규칙을 따르는 것입니다. 이것의 주요 목적은 소스 코드를 더 쉽게 읽고 이해하도록 만드는 것입니다. 따라서 유지 관리 및 확장이 더 쉽습니다.

이 기사에서는 "배드 코드"와 "클리어 코드"가 무엇인지 설명하기 위해 몇 가지 예를 제시하겠습니다.

이름에는 의도가 드러나야 합니다

프로그래밍에서 이름을 어떻게 짓는가는 늘 어려운 문제입니다. 일부 프로그래머는 자신만이 이해할 수 있도록 이름을 단순화하거나 단축하거나 암호화하는 것을 좋아합니다. 몇 가지 예를 살펴보겠습니다.

잘못된 코드:

int d;//일수 int ds;int dsm;int faid;

'd'는 무엇이든 의미할 수 있습니다. 작성자는 자신의 의도를 나타내기 위해 주석을 사용하지만 이를 코드로 표현하지 않기로 결정했습니다. 그리고 'faid'는 ID로 오해되기 쉽습니다.

코드 지우기:

int elapsedTimeInDays;int daysSinceCreation;int daysSinceModification;int fileAgeInDays;

이름 지을 때 오해 없도록 주의사항

잘못된 정보는 정보가 없는 것보다 나쁩니다. 일부 프로그래머는 중요한 정보를 "숨기기"를 좋아하며 때로는 오해의 소지가 있는 코드를 작성합니다.

잘못된 코드:

고객[] customerList;Table theTable;

"customerList" 변수는 실제로 목록이 아닙니다. 이는 일반 배열(또는 고객 모음)입니다. 게다가 "theTable"은 Table 유형의 객체이며(IDE를 사용하여 해당 유형을 쉽게 찾을 수 있음) "the"라는 단어는 불필요한 주의를 분산시킵니다.

코드 지우기:

고객[] 고객;테이블 테이블;

이름은 길이가 적절해야 합니다

고급 프로그래밍 언어에서는 일반적으로 변수 이름의 길이에 제한이 없습니다. 변수 이름의 길이는 거의 제한되지 않습니다. 그러나 이는 코드를 혼란스럽게 만들 수도 있습니다.

잘못된 코드:

var theCustomersListWithAllCustomersIncludedWithoutFilter;var list;

좋은 이름은 개념을 표현하는 데 꼭 필요한 단어만 포함해야 합니다. 불필요한 단어는 이름을 길고 이해하기 어렵게 만듭니다. 문맥에서 완전한 의미를 표현할 수 있는 한 이름이 짧을수록 좋습니다(주문 문맥에서는 "customersInOrder"가 "list"보다 낫습니다).

코드 지우기:

var allCustomers;var CustomersInOrder;

이름을 지정할 때 코딩 표준을 일관되게 유지하고 표준이 코드를 이해하는 데 도움이 되도록 하세요

모든 프로그래밍 기술(언어)에는 코딩 표준이라는 고유한 "스타일"이 있습니다. 다른 프로그래머들도 이 규칙을 알고 이 스타일로 작성하기 때문에 프로그래머는 코드를 작성할 때 이러한 규칙을 따라야 합니다. 명확한 사양이 없는 잘못된 코드의 예를 살펴보겠습니다. 다음 코드는 잘 알려진 "코딩 규칙"(예: PascalCase, camelCase, 헝가리어 규칙)을 따르지 않습니다. 설상가상으로 여기에는 의미 없는 부울 변수 "변경"이 있습니다. 이는 동사(동작을 설명하는 데 사용됨)이지만 여기서 bool 값은 상태를 설명하는 것이므로 형용사가 더 적합할 것입니다.

잘못된 코드:

const int maxcount = 1bool 변경 = truepublic 인터페이스 Repositoryprivate string NAMEpublic 클래스 personaddressvoid getallorders()

코드의 일부만 보면 어떤 유형인지 직접적으로 이해할 수 있으며, 이름 지정 방법만 보면 됩니다.

예를 들어 "_name"이 보이면 private 변수임을 알 수 있습니다. 예외 없이 어디에서나 이 표현을 활용해야 합니다.

코드 지우기:

const int MAXCOUNT = 1bool isChanged = truepublic 인터페이스 IRepositoryprivate string _namepublic class PersonAddressvoid GetAllOrders()

네이밍시 같은 개념을 같은 단어로 표현한

개념을 정의하는 것은 어렵습니다. 소프트웨어 개발 과정에서는 비즈니스 시나리오를 분석하고 그 안에 포함된 모든 요소의 올바른 정의를 생각하는 데 많은 시간이 소요됩니다. 이러한 개념은 프로그래머에게 항상 골치 아픈 문제입니다.

잘못된 코드:

//1. void LoadSingleData ()void FetchDataFiltered ()Void GetAllData ()//2. void SetDataToView ();void SetObjectValue (int 값)

우선:

코드 작성자는 "데이터 가져오기"라는 개념을 표현하려고 했으며, "로드", "가져오기"라는 여러 단어를 사용했습니다. , "얻다" . 개념은 (동일한 맥락에서) 한 단어로 표현될 수 있습니다.

둘째:

"세트"라는 단어는 2가지 개념으로 사용됩니다. 첫 번째는 "보기 위한 데이터 로딩", 두 번째는 "객체의 값 설정"입니다. 이는 서로 다른 두 가지 개념이므로 서로 다른 단어를 사용해야 합니다.

코드 지우기:

//1. void GetSingleData ()void GetDataFiltered ()Void GetAllData ()//2. void LoadDataToView ();void SetObjectValue (int 값)

명칭시 업종과 관련된 단어를 사용하세요

프로그래머가 작성한 모든 코드는 비즈니스 도메인 시나리오와 논리적으로 연결됩니다. 문제와 관련된 모든 사람에게 더 나은 이해를 제공하기 위해 프로그램은 해당 도메인의 맥락에서 의미 있는 이름을 사용해야 합니다.

잘못된 코드:

public class EntitiesRelation{Entity o1;Entity o2;}

도메인과 관련된 코드를 작성할 때는 항상 도메인 관련 이름 사용을 고려해야 합니다. 미래에 다른 사람(프로그래머, 테스터 등)이 귀하의 코드를 접하게 되면 해당 비즈니스 영역에서 귀하의 코드가 무엇을 의미하는지 쉽게 이해할 수 있습니다(비즈니스 논리 지식이 필요하지 않음). 가장 먼저 고려해야 할 사항은 비즈니스 문제이고 그 다음에는 이를 해결하는 방법입니다.

코드 지우기:

공개 클래스 ProductWithCategory{엔티티 제품;엔티티 카테고리;}

이름을 지을 때는 특정 문맥에서 의미가 있는 단어를 사용하세요.

코드의 이름에는 고유한 컨텍스트가 있습니다. 문맥은 추가 정보를 제공하므로 이름을 이해하는 데 중요합니다. 일반적인 "주소" 컨텍스트를 살펴보겠습니다.

잘못된 코드:

문자열 addressCity;문자열 주소HomeNumber;문자열 addressPostCode;

대부분의 경우 "우편번호"는 일반적으로 주소의 일부입니다. 우편번호를 특별히 처리하는 애플리케이션을 개발하지 않는 한 우편번호는 단독으로 사용할 수 없습니다. 따라서 "PostCode" 앞에 "주소"를 추가할 필요가 없습니다. 더 중요한 것은 이 모든 정보에 컨텍스트, 네임스페이스 및 클래스가 있다는 것입니다.

객체 지향 프로그래밍에서는 이 주소 정보를 표현하기 위해 "주소" 클래스를 사용해야 합니다.

코드 지우기:

class Address{string city;string homeNumber;string postCode;}

네이밍 방법 요약

요약하자면, 프로그래머는 다음을 수행해야 합니다.

· 이름은 개념을 표현하는 데 사용됩니다.

· 이름 길이에 주의하세요. 이름에는 필요한 단어만 포함해야 합니다.

· 코딩 표준은 이해에 도움이 됩니다. 코드를 사용해야 합니다

· 이름을 혼합하지 마세요

· 이름 비즈니스 영역에서 맥락에 맞게 이해되어야 합니다

첨부 파일 및 텍스트 업로드 제한으로 인해 일부 사진과 텍스트가 표시되지 않을 수 있습니다. 자세한 내용은 http://mp.weixin.qq.com/s?__biz=MzI5ODI3NzY2MA==&mid=100000563&idx=2&sn=을 참조하세요. 528dc490ec0d0a230b8503d71d9a3e63#rd
모든 분들과의 소통을 환영합니다.
아래 QR코드를 스캔하시면 더 많은 아름다운 기사를 만나보실 수 있습니다! (예상치 못한 놀라움을 보려면 QR 코드를 스캔하세요!!)

WeChat 구독 계정(uniguytech100)과 서비스 계정(uniguytech)을 팔로우하여 더 많은 멋진 기사를 받아보세요!
[모두 기술 네트워크 토론 QQ 그룹], 그룹 번호: 256175955에 참여하실 수도 있습니다. 개인 소개를 적어주세요! 그것에 대해 함께 이야기합시다!