PHP 스니펫 정리하기

읽기 어려운 스니펫은 답변을 적게 받습니다. 여기에 코드를 붙여 넣으면 문장마다 한 줄씩, 일정한 들여쓰기로 정리됩니다. 그다음 티켓, 채팅 메시지, 포럼 질문, 문서에 복사해 넣으세요. 몇 초면 끝나며 짧은 예제에 가장 잘 맞습니다.

공유용 스니펫 준비 방법

  1. 1

    먼저 코드를 줄이기

    질문과 관계없는 부분을 지우고, 비밀번호, 키, 실제 이름은 자리표시자로 바꾸세요.

  2. 2

    붙여 넣기

    줄인 스니펫을 PHP 코드 상자에 붙여 넣고 2칸 또는 4칸을 고르세요.

  3. 3

    결과로 이동하기

    정리된 버전을 여세요.

  4. 4

    복사해서 게시하기

    원본과 비교해 확인한 뒤, 게시할 곳의 코드 블록에 붙여 넣으세요.

서식이 읽는 사람에게 도움이 되는 이유

사람은 코드를 모양으로 훑어 읽습니다. 중괄호가 줄을 맞추고 각 문장이 자기 줄을 가지면, 독자는 단어를 하나 읽기도 전에 구조를 파악합니다. 리뷰어도 빠진 중괄호나 잘못 놓인 반복문을 쉽게 찾아냅니다. 줄바꿈 없는 글자 덩어리는 이런 것들을 모두 가립니다.

정리 전과 후

원본, 로그에서 복사한 코드:

<?php function total($items){$sum=0;foreach($items as $item){$sum+=$item["price"];}return $sum;}

4칸으로 정리한 결과:

<?php function total($items)
{
    $sum=0;
    foreach($items as $item)
    {
        $sum+=$item["price"];
    }
    return $sum;
}

게시 전 체크리스트

  • 비밀 정보를 지우세요. 여기에 붙여 넣은 텍스트는 서버에서 처리되므로 실제 자격 증명, 토큰, 고객 데이터를 쓰지 마세요.
  • 문제를 보여 주는 데 필요한 줄만 남겨 예제를 최소화하세요.
  • 사용 중인 PHP 버전과 기대한 동작을 함께 적으세요.
  • 정리된 코드를 원본과 비교하세요. 이 도구는 레이아웃만 바꾸지만, 공백 규칙 때문에 주석이나 문자열이 영향을 받을 수 있습니다.
  • 들여쓰기가 유지되도록 결과를 코드 블록 안에 넣으세요.

이 도구가 하지 않는 일

오류를 찾거나, 코드를 실행하거나, 스타일 규칙을 검사하지 않습니다. 깔끔한 레이아웃은 문제를 더 잘 보이게 할 뿐, 문제를 고쳐 주지는 않습니다.

도움이 되는 경우

  • 코드 샘플이 포함된 지원 티켓이나 버그 보고서.
  • 개발자 포럼이나 채팅 채널의 질문.
  • 예제를 깔끔하게 보여 줘야 하는 문서나 튜토리얼 페이지.
  • 함수 일부를 바꾸자고 제안하는 리뷰 댓글.

어느 경우든 독자는 문제보다 구조를 먼저 보게 되며, 이것이 바람직한 순서입니다.

스니펫을 정직하게 유지하기

더 깔끔하게 다시 쓴 코드가 아니라, 실제로 게시할 코드를 정리하세요. 예제에 맞추려고 변수 이름을 줄이거나 줄을 지웠다면, 먼저 직접 줄인 버전을 실행해 보세요. 문제를 재현하지 못하는 깔끔한 스니펫은 독자의 시간만 낭비합니다. 예상 결과에 대한 메모를 덧붙일 때는 코드 블록 위에 평이한 말로 적으세요.

자주 묻는 질문

아니요. 먼저 비밀번호, 키, 개인 데이터를 자리표시자로 바꾸세요. 붙여 넣은 텍스트는 정리를 위해 서버로 전송됩니다.

일반 코드라면 공백만 바뀝니다. 다만 주석, heredoc, 쉼표가 있는 문자열은 바뀔 수 있으니 결과를 원본과 비교하세요.

아니요. 문법을 검사하지 않고 스니펫을 실행하지도 않습니다. 코드의 레이아웃만 개선합니다.

이 도구는 짧은 스니펫용입니다. 긴 파일에는 에디터에 설정된 포매터가 더 적합합니다.

관련 도구

이 도구는 다른 언어로도 제공됩니다

사용 가이드와 활용 사례