PhpCodeArcheology

phpcodearcheology

PHPCodearcheology는 PHP 프로젝트를 분석하여 파일, 클래스, 방법 및 기능에 대한 자세한 메트릭을 제공합니다. 포괄적 인 HTML 보고서는 프로젝트를 평가하는 데 필요한 깊은 통찰력을 제공합니다.

왜 phpcodearcheology인가?

PHPCodearcheology는 세부 메트릭과 통찰력을 제공함으로써 개발자가 PHP 코드베이스에 대한 더 깊은 이해를 얻을 수 있도록 만들어졌습니다. 레거시 시스템을 유지하든 새로운 프로젝트를 수행하든이 도구는 더 나은 코드 품질과 유지 관리를 용이하게하는 것을 목표로합니다.

전제 조건

환경이 다음 요구 사항을 충족하는지 확인하십시오.

• PHP 버전 8.2 이상
• 작곡가 설치

설치

터미널에서 다음 명령을 실행하여 작곡가를 사용하여 phpcodearcheology를 설치하십시오.

 composer require --dev php-code-archeology/php-code-archeology

빠른 시작

phpcodearcheology를 시작하려면 프로젝트 루트에서 다음 명령을 실행하십시오.

 ./vendor/bin/phpcodearcheology

Phpcodearcheology는 SRC DIR을 스캔하고 TMP/Report 에서 보고서를 작성합니다.

폴더 포함 또는 제외, 사용자 정의 PHP 파일 확장자 또는 기타 설정 정의와 같은 스캔을 사용자 정의하려면 프로젝트 루트에서 php-codearch-config.yaml 구성 파일을 만듭니다. 안내는이 샘플 구성 파일을 참조하십시오.

보고서

phpcodearcheology에 의해 생성 된 전형적인 보고서에는 다음과 같은 메트릭이 포함됩니다.

• 파일 : 프로젝트의 총 파일 수.
• 파일 오류 : 파일에서 발견 된 오류 수.
• 함수 수 : 총 함수 수.
• 클래스 카운트 : 총 클래스 수.
• 초록 수업 : 추상 수업 수.
• 인터페이스 수 : 총 인터페이스 수.
• 메소드 수 : 공개, 개인 및 정적 방법을 포함한 총 방법 수.
• 공개 방법 : 공개 방법 수.
• 개인 방법 : 개인 방법 수.
• 정적 방법 : 정적 방법 수.
• 출력 명세서 : Echo 및 Printf 호출 수.
• 코드 라인 (LOC) : 주석 및 빈 줄을 포함한 총 코드 줄.
• 논리 코드 라인 (LLOC) : 주석과 빈 줄을 제외한 총 코드 줄.
• 주석 줄 (CLOC) : 주석을 포함하는 코드 줄.
• HTML 코드 라인 : HTML을 포함하는 코드 라인.
• 순환 복잡성 (CC) : 코드의 복잡성 측정.
• 유지 관리 지수 (MI) : 코드의 유지 관리를 나타내는 색인.
• LCOM : 수업에서 방법의 응집력 부족.
• 불안정성 : 종속성에 따른 클래스의 안정성 측정.
• efferent 커플 링 (CE) : 클래스가 의존하는 클래스 수.
• 구 심성 커플 링 (CA) : 클래스에 의존하는 클래스 수.
• 난이도 : 코드가 이해하기 어려운지 측정합니다.
• 노력 : 코드를 이해하는 데 필요한 노력의 추정.
• 어휘 : 코드의 고유 한 연산자 및 피연산자 수.
• 길이 : 코드의 총 사업자 및 피연산자 수.
• 볼륨 : 코드 어휘의 크기와 길이.
• 댓글 무게 : 코드의 주석 가중치.
• 메인 라인과의 거리 : 수업이 얼마나 추상적이고 안정적인 지 측정합니다.

다음은 HTML 보고서의 샘플 스크린 샷입니다.

선적 서류 비치

나는 현재 문서를 연구하고 있습니다. 주로 내 프로젝트에 도구를 사용하고 지속적인 개발에 중점을 두므로 포괄적 인 문서를 작성하는 데 시간이 걸릴 수 있습니다.

작가

Marcus Kober, @mrcskbr, github