요약
이 코드 설명기는 붙여넣은 코드 조각을 명확한 설명으로 변환합니다: 사용 언어, 각 함수의 역할, 순환 복잡도 점수, 빈 catch 블록이나 eval 호출, 하드코딩된 시크릿 같은 위험 요소. 규칙 기반 리더로서 언어 모델이 아니므로 의도가 아닌 구조를 설명합니다. 복잡도는 McCabe 방식을 따르며 함수당 10 이하가 권장됩니다. 분석은 브라우저에서 실행되며 코드는 절대 서버로 전송되지 않습니다.
코드를 붙여넣으면 자연스러운 설명을 얻습니다
이 무료 코드 설명기는 브라우저에서 코드 조각을 읽고 함수, 의사결정 경로, 예외 처리, 위험 요소를 반환하므로 한 줄씩 읽기 전에 어디를 봐야 하는지 알 수 있습니다.
설명기를 사용하는 방법
-
1
코드 조각 붙여넣기
한 함수 또는 한 파일이 최적입니다. 몇 백 줄을 넘으면 설명이 요약이 아닌 목록이 됩니다.
-
2
리드 문장 확인하기
언어를 이름짓고 함수를 세며 복잡도 점수를 제공합니다. 10을 넘으면 코드 경로가 많아서 한 번에 이해하기 어렵습니다.
-
3
분석 결과 읽기
각 함수는 한 줄로: 이름이 무엇을 시사하는지, 길이는 얼마나 되는지, 경로는 몇 개인지, 루프와 대기, 실패 처리 여부.
-
4
플래그부터 확인하기
도구가 빈 예외 처리자나 자격 증명 같은 문자열을 나열하면 거기서 시작하세요. 이것들이 나중에 가장 많이 상처를 줄 가능성이 높습니다.
설명기가 실제로 측정하는 것
문법에서 구조 파악
주석과 문자열을 제거한 후 감지된 언어의 함수 정의, import, 클래스, 루프, 분기를 매칭합니다. 코드가 뭘 하는지는 추측하지 않고 뭘 포함하고 있는지만 봅니다.
확인 가능한 복잡도
점수는 순환 복잡도입니다: 1에 모든 if, 루프, case, catch, 불리언 연산자를 더합니다. 린터가 주는 수와 같으며, NIST 구조 테스트 보고서는 함수당 10 이하를 제안합니다.
실제 버그와 일치하는 플래그
eval/exec 호출, 빈 catch 블록, 하드코딩된 시크릿, TODO 메모, 4단계 이상의 중첩, 40줄 이상 함수. 각 규칙은 오독하기 쉬운 코드를 가리키기 때문에 존재합니다.
코드 조각 설명기는 '여기에 뭐가 있는가'를 답하지, '왜 여기 있는가'는 아닙니다
새로운 엔지니어가 묻는 질문은 '이 루프가 뭘 하는가'가 아니라 '청구 서비스가 왜 이 함수를 호출하고, 다른 누가 의존하는가'입니다. 붙여넣은 조각은 그 답변을 줄 수 없습니다. 답변은 다른 파일에 있기 때문입니다. 이 도구는 첫 번째 패스를 위한 것입니다: 함수를 열었고, 5분이 있으며, 10줄 헬퍼인지 6개 종료 경로가 있는 엉킴인지 알고 싶습니다. 1초 안에 그것을 주고 위험이 어디 있는지 말합니다. 두 번째 질문에는 전체 저장소에서 검색이 필요합니다. 이것이 한 함수를 읽는 것과 시스템이 어떻게 연결되는지 이해하는 것 사이의 간격이며, 대부분의 온보딩 시간이 여기에 갑니다.
- 전체 서비스가 아닌 단일 함수나 파일에 사용하세요
- 플래그를 최종 판단이 아닌 더 자세히 봐야 할 신호로 취급하세요
- 질문이 호출자와 의존성에 대한 것이면 저장소 전체 검색으로 전환하세요
전체 저장소를 이해하세요, 한 조각이 아니라
codebasechat은 각 답변을 뒷받침하는 파일과 호출 지점과 함께 일반 영어로 코드베이스에 대한 질문에 답합니다.