초보자를 위한 소스코드 읽는 방법-프런트엔드 Q&A-php.cn

초보자를 위한 소스코드 읽는 방법

관련 학습 권장 사항: javascript

저는 프로그래밍을 좋아하고, 이것이 제 직업이며, 대부분의 시간을 소프트웨어 개발에 보낼 수 있어서 기쁩니다. 많은 프로그래머들처럼 나도 내가 작성한 코드가 얼마나 좋은지, 어떻게 하면 더 잘 작성할 수 있는지에 매료되기도 하고 혼란스럽기도 했습니다.

수년에 걸쳐 저는 소프트웨어 개발에 관한 많은 기사와 책을 읽었습니다. 프로그래밍을 향상시키고 닌자처럼 전문적으로 훈련받은 프로그래밍 마스터가 되는 방법을 알려주는 잉크북(책이나 온라인)이 많이 있습니다! 이러한 제안의 대부분에는 공통점이 있는데, 그 중 하나는 소스 코드를 읽는 것입니다. 그러나 다른 제안에 비해 소스 코드를 읽는 것은 일반적으로 간단한 문장으로 귀결됩니다. 훌륭한 오픈 소스 소프트웨어나 원하는 소프트웨어를 찾아 열어서(또는 인쇄하여) 읽으십시오. 일반적으로는 좋은 제안이긴 하지만, 종이상으로는 얕고, 실제로 실행해 보면 문제가 많습니다. 이번 글에서는 소스코드 읽기에 대한 실용적인 조언을 드리고자 합니다. 하지만 그 전에 먼저 문제점을 열거해 보겠습니다.

소스 코드 읽기에 대한 오해

사람들이 소스 코드 읽기에 대해 이야기할 때, 일반적으로 의자에 앉아 소설처럼 손에 코드를 읽는 프로그래밍 마스터와 같다는 인상을 받습니다. 뭐, 영어 문장과 유사한 신비한 기호들을 보면서 커피를 즐길 수 있고, 전체 클래스 계층 구조와 시스템을 마음 속에 구축할 수 있는 훌륭한 프로그래머도 분명 있을 것입니다. 분명히 이 글의 독자는 나 같은 사람들을 위한 것이 아니다. 소스 코드 더미를 쳐다보는 것이 지루하고 의미 없는 연습을 보는 것과 같다고 생각하는 사람들이다. 물론 어떤 사람들은 하나의 클래스나 하나의 함수를 조금씩 살펴보면서 완전한 프로젝트에서 배울 수 있다고 주장하지만, 내 생각에는 가장 간단한 문제를 제외하면 대부분의 소프트웨어는 내부적으로 서로 의존적입니다. 시스템의 나머지 부분을 이해하지 않고서는 특정 기능이나 클래스 뒤에 숨은 디자인 아이디어와 원리를 이해하는 것이 불가능한 경우가 많습니다.

다음 질문은 읽을 수 있는 소스 코드를 어디서 구할 수 있느냐는 것입니다(물론 그 전에 어떤 소스 코드를 읽을 가치가 있는지 식별할 수 있어야 합니다). 훌륭한 소프트웨어가 많이 있습니다. 오픈 소스 소프트웨어는 모두 무료로 제공되며, 비공개 소스 소프트웨어에는 라이센스가 필요합니다. 오픈 소스 리포지토리에는 Sourceforge 및 GitHub가 포함됩니다. 소프트웨어 개발 회사에서 근무하는 경우 소스 코드 저장소에 있는 독점 코드에 액세스할 수 있습니다. 세 번째 일반적인 접근 방식은 소프트웨어 개발 서적과 함께 제공되거나 교육 리소스로 제공되는 프로그램입니다(Minix가 대표적인 예입니다). 실제로 옵션이 너무 많아서 선택하기가 어렵기 때문에 방대한 코드 세계에서 읽을 수 있는 올바른 옵션을 찾는 것은 어렵지만 필수적인 작업입니다.

또 다른 문제는 프로그램에 사용되는 프로그래밍 언어입니다. 다른 사람의 코드를 읽는 것도 충분히 어렵습니다. 이상한 구문이 혼합된 새로운 언어에 익숙해져야 한다면, 그것이 가져오는 부담은 간단합니다... 큰 좌절감을 안겨줍니다. 따라서 익숙한 언어로 작성된 코드를 찾아야 합니다. 하지만 보고 있는 코드가 책에서 나온 코드이거나 교육 자료로 제공되는 코드라면 맥락을 설명해줄 강사가 있기 때문에 새로운 언어를 알고 있는지 여부는 중요하지 않습니다. 산에 호랑이가 있다는 것을 알고 있지만 책이나 교사의 지도 없이 익숙하지 않은 프로그래밍 언어를 읽는 것을 선호한다면, 적어도 그 언어를 배우고 글을 쓸 수 있는 지점에 도달해야 한다고 제안합니다. 자체 프로그램입니다(Hello World는 포함되지 않습니다 하하).

컨텍스트에 대한 이전 질문은 다음 질문으로 이어집니다. 소프트웨어 자체에 익숙하지 않은 경우 코드가 수행하는 작업을 파악하는 것이 훨씬 어렵습니다. 예를 들어, 매일 Linux를 사용하지 않고 Linux 부팅 순서를 알고 있다면 Linux 코드를 살펴본 후 런레벨이 무엇인지 파악하기가 어렵습니다. 특정 소프트웨어를 사용하면서 얻은 경험과 지식은 일반적으로 사용되는 용어, 소프트웨어의 기능 및 특징, 심지어 발생하는 다양한 오류까지 포함하여 소스 코드를 더 잘 읽는 데 도움이 될 수 있습니다.

소스 코드 이해하기

저에게는 '소스 코드를 읽는다'가 내가 하고 있는 활동을 정확하게 설명하는 것이 아니며, '소스 코드 이해'를 사용하는 것이 더 적합하다는 것을 깨달았습니다. 랩톱 화면 앞에 앉아(또는 종이에 인쇄하여) 코드로 가득 찬 화면을 읽는 것은 매우 어렵습니다. 코드 외에 다른 것도 필요합니다. 예를 들어, 저는 문서를 살펴보고, 소프트웨어를 가지고 놀고, 코드를 단계별로 실행하고, 심지어 이를 실행하기 위한 테스트 코드를 작성하는 것을 좋아합니다. 여기에 너무 많은 시간과 에너지를 투자하기 때문에 매우 선별적으로 "읽고"(이해하고) 싶은 소프트웨어를 찾아야 합니다.

제 첫 번째 필터링 수준은 프로그래밍 언어입니다. 저는 C#, VB.NET, Python 및 Javascript로 작성된 프로그램 코드만 읽었습니다. (비록 C++, Ruby 및 F#에도 익숙하지만 그렇게 생각하지 않습니다. 나는 다른 사람의 코드를 이해할 수 있는 수준이다.) 다음은 코드의 의도와 코드가 수행할 수 없는 작업 및 제한 사항을 알고 있기 때문에 이미 사용하고 있는 것 같은 느낌을 주는 소프트웨어를 찾는 것입니다(코드에 충분히 익숙하다면). . 제가 매일 사용하는 오픈 소스 소프트웨어는 훌륭한 후보입니다. (예를 들어 저는 C#으로 작성된 오픈 소스 도구인 Cruise Control.NET, NANT 및 NUnit을 사용합니다.)

저는 우연히 소프트웨어 제품 회사(Microsoft 회사)에서 근무했습니다. , 그래서 제가 읽은 소스 코드 선택 중 하나는 소스 코드 저장소에 있는 우리 회사의 코드였습니다. 소프트웨어 회사에서도 근무하게 된다면 다른 프로젝트나 작업했던 프로젝트의 이전 버전을 살펴볼 수도 있습니다. 이렇게 하면 코드에 대한 더 깊은 이해를 얻을 수 있을 뿐만 아니라 이전과 이후에 무엇을 시도했는지에 대한 좋은 아이디어도 얻을 수 있습니다. 하지만 주의해야 할 몇 가지 주의 사항이 있습니다:

먼저, 다른 프로젝트에 액세스할 수 없는 경우 일부 회사는 "지적 재산"을 매우 중요하게 여기기 때문에 허가를 요청해야 합니다.
둘째, 일반적으로 독점 코드는 오픈 소스 코드만큼 엄격한 코드 검토를 거치지 않았기 때문에 이러한 소프트웨어의 품질은 생각만큼 높지 않을 수 있습니다. 정기적인 코드 검토가 없으면 코드 품질이 저하될 수 있다는 점에 유의하는 것이 중요합니다.
셋째(친구들이 제공한 피드백에서 영감을 얻었음), 회사에서 비즈니스 소프트웨어(HR, 재무, ERP 등)를 개발하는 경우 먼저 이해해야 할 비즈니스 관계가 많이 있습니다. 또한 대부분의 코드는 비즈니스 기능 요소의 영향을 받기 때문에 일반적으로 애플리케이션이나 API만큼 모듈화되지 않습니다.

잘 문서화된 프로젝트를 찾으세요(이는 독점 코드뿐만 아니라 오픈 소스에도 적용됩니다). 이것이 의미하는 바는 그러한 문서가 전반적인 디자인을 강조하고 코드의 근거를 설명해야 한다는 것입니다. 단순히 자동으로 생성된 Java Doc 유형 문서라면 내가 설명하는 문서로 간주되지 않습니다. :-). 이를 찾는 한 가지 방법은 Minix와 같은 교육용으로 만들어진 소프트웨어를 이용하는 것입니다. 그들의 목적은 소프트웨어를 통해 가르치는 것이기 때문에 일반적으로 매우 명확하게 문서화되어 있으며 코드 뒤에 숨은 디자인 원칙을 설명하는 많은 자료를 가지고 있습니다.

요약

이제 소스 코드를 읽고 싶은 소프트웨어를 식별하고 해당 소스 코드와 문서를 다운로드했으므로 단계별로 읽고 이해해 보겠습니다.

디자인 문서를 살펴보고 다음을 시도해 보세요. 코드가 어떻게 작성되는지 이해합니다. 좋은 소프트웨어 프로젝트는 코드 구성을 결정하는 특정 아키텍처 패턴을 따릅니다. 이것을 마스터하고 나면 코드를 이해하는 것이 훨씬 쉬워집니다. 클래스 다이어그램도 그릴 수 있다면 전체적인 레이아웃을 더 잘 이해할 수 있습니다.
다음으로 할 일은 컴파일하고 실행하는 것입니다. 프로젝트와 문서에 따라 이는 쉬울 수도 있고 어려울 수도 있습니다.
이제 즐겨찾는 IDE를 열고 탐색을 시작할 시간입니다. 탐색을 위한 좋은 시작점은 익숙한 기능의 코드를 단계별로 실행해 보는 것입니다. 이런 방식으로 다양한 계층과 하위 시스템을 탐색하고 이들이 어떻게 관련되어 있는지 이해할 수 있습니다. 예를 들어, NUnit을 탐색할 때 먼저 테스트 케이스를 작성한 다음 관련된 클래스를 살펴보았습니다.
코드에 사용된 디자인 패턴을 식별해 보세요. 아직도 디자인 패턴이 무엇인지 모른다면, 이 글을 즉시 읽지 말고 디자인 패턴에 관한 고전 책을 읽어보세요. 디자인 패턴에 익숙해지면 좋은 코드에 포함된 디자인을 식별하고 이해하는 좋은 방법입니다. 익숙해지면 코드를 읽을 때 염두에 두기가 더 쉬울 것입니다. 또한 코드 작성자가 원래 디자인 패턴에 적용한 미묘한 조정과 놀라운 변경 사항을 더 쉽게 식별하는 데 도움이 될 수 있습니다.
코드를 완전히 이해하기 위해 테스트 사례를 작성해보세요. 이는 코드의 여러 부분 간의 종속성을 이해하는 데 매우 유용한 방법입니다. 테스트 케이스를 작성하기 전에 먼저 모든 종속성을 충족해야 합니다. 다음으로, 코드의 가능한 진입점과 반환 값에 대해 알아보세요. 이를 통해 코드에 대한 이해가 향상되고 다음 단계로 넘어갈 수 있습니다.
마지막으로 코드를 리팩터링해 보세요. 이 시점에서는 단순히 코드를 이해하는 것에서 코드를 수정할 수 있을 만큼 익숙해지는 수준으로 이동했습니다. 리팩토링의 복잡성이 증가할수록 이해도도 높아집니다. 이 시점에서 원하는 경우 프로젝트에 자신의 코드를 제공할 수 있습니다.

내 생각에 "소스 코드 읽기"는 단순히 읽는 것 이상으로 사람들이 코드를 이해하도록 돕기 위해 함께 작동하는 독특한 활동 세트입니다. 이는 단순히 "코드를 읽는 것"보다 더 위협적으로 보일 수 있지만 노력할 가치가 있습니다.

이제, 좀 더 쉽고 즐겁게 "소스코드 읽기"를 할 수 있나요?