PHP에서 읽을 수 있는 코드를 작성하는 방법

성공적인 개발 팀은 팀의 모든 구성원이 코드 재사용 규칙을 준수해야 합니다. 이러한 규칙은 개발자의 창의성과 개발 효율성을 크게 저하시키지 않으면서 코드 재사용성을 극대화합니다. 코드를 작성하고 사용하는 개발자가 공통 프로그램 명명 규칙 코드 및 코드 comment 요구 사항을 준수하면 코드의 재사용성이 크게 향상됩니다. 이러한 표준의 출발점은 시스템 아키텍처 수준에 있습니다. 기능 사양은 클래스 정의, 속성 이름, 함수 반환 값 및 기타 주요 프로그램 요소에 이러한 표준을 반영해야 합니다. 이 기사에서는 독자가 자신만의 코드 재사용 표준을 개발하는 데 도움이 되는 기본 명명 규칙 및 주석에 대한 몇 가지 실용적인 제안을 제공합니다.

대소문자 표준

다양한 프로그램 요소의 이름을 지정하는 올바른 방법을 논의하기 전에 먼저 요소의 대소문자를 구별하는 가장 일반적인 두 가지 방법을 정의하겠습니다.

Pascal 사양 - 첫 번째 문자 대문자화 및 InvoiceNumber 또는 PrintInvoice와 같이 대상 이름에 있는 각 단어의 첫 글자도 대문자로 표시됩니다. 다른 모든 문자는 소문자입니다.
Camel 사양 - 첫 번째 문자는 대문자로 표시되지 않지만 대상 이름에 있는 각 단어의 첫 글자는 대문자로 표시됩니다(예:invoiceNumber). 다른 모든 문자는 소문자입니다.
그러나 요소를 구별하기 위해 대소문자를 사용하면 대소문자를 구분하지 않는 프로그래밍 언어에서는 문제가 발생할 수 있습니다. 예를 들어 C# 언어는 대/소문자를 구분하므로 전용 변수인 Employee를 호출하면 해당 공용 속성인 Employee를 호출자가 사용할 수 있습니다. 이러한 작업은 완전히 합법적입니다. 그러나 VB는 대소문자를 구분하지 않고 위의 두 요소가 VB의 눈에는 동일하기 때문에 Visual Basic에서는 오류가 발생합니다. 혼합 언어 환경에서 작업하는 경우 개발자가 다른 사람이 개발한 코드를 읽기 위해 여러 언어를 합리적으로 사용하도록 요구하는 특정 규칙만 지정할 수 있습니다.


이름 지정 표준
위의 사례 표준을 채택한다고 가정하고 이제 공통 프로그램 요소에 대한 몇 가지 간단한 이름 지정 제안을 살펴보겠습니다.

클래스
일부 클래스는 실제 개체를 시뮬레이션하도록 설계되었습니다. 이러한 클래스의 경우 선택한 이름은 실제 개체를 반영해야 하며 Employee, Invoice 또는 Timecard 등과 같은 단일 명사 형식을 사용해야 합니다. 내부 클래스의 경우 Pascal 사양을 사용하여 결과 클래스가 ThreadPool 또는 CustomColor 등과 같은 단일 이름을 갖도록 만들 수 있습니다. 클래스는 복수형이 Employees 배열 등과 같은 동일한 유형의 컬렉션 이름을 나타낼 수 있도록 단수형이어야 합니다.

클래스 멤버
C# 및 기타 대소문자 구분 프로그래밍 언어를 사용하는 개발자는 클래스 멤버 이름을 지정할 때 낙타 규칙을 사용해야 합니다. 이렇게 하면 개발자가 내부 변수 이름과 공용 속성 이름을 더 쉽게 구별할 수 있습니다. 많은 VB 개발자는 헝가리어 명명법을 사용하여 클래스 멤버의 이름을 지정하는 것을 선호합니다. 즉, 이름 앞에 접두사를 추가하여 변수 유형을 나타내는 것을 선호합니다. 예를 들어 sName은 string 유형의 이름 변수를 나타냅니다. VS.NET과 같은 고급 개발 환경에서는 이 작업을 수행할 필요가 없다고 생각합니다. 이 경우 시스템 마우스를 변수 위에 놓으면 시스템의 변수 유형이 자동으로 표시될 수 있기 때문입니다. 저는 개인적으로 반원 이름 앞에 소문자 m을 붙이는 것을 좋아합니다. 이러한 방식으로 내부 변수는 충분한 내부 클래스 정보를 저장합니다. 내부 변수 mName은 공용 속성 Name을 나타냅니다.

메서드
메서드는 파스칼 사양에 따라 이름을 지정하고 구현 동작을 합리적인 방식으로 설명해야 합니다. 예를 들어, 데이터베이스에 직원을 추가하는 방법의 이름은 AddEmployee로 지정할 수 있고, 송장을 인쇄하는 방법의 이름은 PrintInvoice로 지정할 수 있습니다. 메서드가 부울 값을 반환하는 경우 메서드 이름은 동사로 시작해야 if 문에서 사용될 때 의미가 더 명확해집니다. 예를 들어 직원이 회사의 401k 계획에 적합한지 여부를 결정하는 메서드가 있는 경우 If 문에서 IsEligible401k 메서드를 호출할 수 있습니다. If IsEligible401k then...

메서드 매개 변수, 반환 값 및 변수
All 메소드 매개변수, 반환 값, 변수는 모두 파스칼 사양에 따라 이름을 지정해야 합니다. 메소드 이름과 마찬가지로 매개변수나 변수의 의미도 반영해야 합니다. 이는 메서드를 호출할 때 Intellisense가 매개 변수 이름과 매개 변수 유형을 반환하기 때문에 매개 변수 메서드의 경우 특히 중요합니다. 메소드를 사용하는 모든 개발자는 그 의미를 쉽게 이해할 수 있도록 설명적인 이름과 유형을 사용해야 합니다.

컨트롤
컨트롤 이름 지정은 개발 환경에서 종종 논란이 되는 문제입니다. 대부분의 사람들은 TextBox1 또는 Label1 등과 같은 컨트롤의 기본 이름을 사용해서는 안 된다는 데 동의하지만 컨트롤 이름을 변수로 지정하거나 접두사를 사용하여 컨트롤 유형을 나타내는 것에 반대합니다. 나는 양식의 컨트롤 이름을 지정하기 위해 표준 3글자 접두사를 사용하는 것을 선호합니다. 예를 들어 이름과 성을 저장하는 텍스트 상자 컨트롤의 이름은 각각 txtLastName 및 txtFirstName으로 지정될 수 있습니다. 양식 데이터를 처리하는 명령 단추의 이름은 cmdSubmit 또는 cmdCancel로 지정할 수 있습니다. 실제로, 컨트롤 이름이 일관되고 표준이 이해하기 쉽다는 것을 확인할 수 있다면 말이죠.

댓글
코드에 댓글을다는 것은 모든 개발자에게 필수입니다. 적절한 주석 기술을 가르치기 위해 나는 종종 데모 프로그램에 주석이 달린 코드를 추가합니다. 또한 주석 프로세스를 단순화하기 위해 개발자는 먼저 작성하려는 프로그램을 설명하는 주석을 작성하는 것이 좋습니다. 먼저 프로그램의 프로시저, 클래스 또는 기타 프로그램 요소를 설명하기 위해 주석을 작성하지만 작동 방식에 대해서는 설명하지 않습니다. 그런 다음 프로세스의 각 주요 단계나 클래스 요소를 설명하는 일련의 주석 처리된 코드를 작성했습니다. 클래스를 정의하거나 프로세스를 설명하는 코드를 작성한 후 각 외부 변수, 컨트롤, 열린 파일, 심지어 다른 프로세스에서 액세스하는 요소까지 문서화하고 입력 매개 변수 및 반환 값을 간략하게 설명합니다.

C#을 사용하여 프로그램을 개발하는 경우 VS.NET 환경에는 내부 C# 주석을 외부 HTML 문서로 변환하는 데 도움이 되는 도구가 이미 내장되어 있습니다. 자신의 문서에 특수 처리 지시문을 추가하여 외부 문서가 표시되는 방식을 변경할 수 있습니다. 이에 대한 자세한 내용은 VS.NET 내부 도움말 파일(ms-help://MS.VSCC/MS.MSDNVS/csref/html/vcoriXMLDocumentation.htm)을 참조하세요.

위 내용은 PHP에서 읽을 수 있는 코드를 작성하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!