PHP 입문 문법

PHP 주석과 코드 스타일

PHP 주석과 코드 스타일 — 초급

주석과 코드 스타일

1. 도입 (왜 배워야 하는가)

코드는 단순히 컴퓨터가 이해하는 언어로 작성하는 것이 아닙니다. 사람도 이해할 수 있게 작성해야 하며, 이를 실현하는 중요한 요소가 바로 주석과 코드 스타일입니다. 주석은 코드의 의도를 설명하고, 코드 스타일은 일관성을 유지하여 가독성을 높입니다.

만약 주석을 제대로 작성하지 않거나 일관된 코드 스타일을 지키지 않으면, 협업 시 다른 개발자들이 코드를 이해하기 어려워질 수 있습니다. 이는 버그를 초래하거나, 유지보수 비용을 증가시키는 문제로 이어질 수 있습니다.

2. 핵심 개념 설명

주석

정의: 코드 내에 작성된 설명으로, 컴퓨터가 실행하지 않는 부분입니다. 코드의 의도나 기능을 설명하는 데 사용됩니다.
비유: 책의 주석은 독자가 내용을 쉽게 이해할 수 있도록 도와주는 역할을 합니다.

코드 스타일

정의: 코드의 서식을 정리하는 방법으로, 들여쓰기, 줄 간격, 변수명 규칙 등을 포함합니다.
비유: 깔끔하게 정리된 책장은 찾고자 하는 내용을 더 쉽게 찾을 수 있게 합니다.

용어	설명
주석	코드 설명을 위한 텍스트
코드 스타일	코드의 형식 및 서식 규칙
가독성	코드가 얼마나 쉽게 읽히는지

3. 기본 코드 예제

다음은 PHP에서 주석을 사용하는 기본 예제입니다.

<?php
// 변수 선언
$greeting = "안녕하세요"; // 인사말을 저장합니다.

// 인사말 출력
echo $greeting; // 변수의 내용을 출력합니다.
?>

실행 결과:

안녕하세요

// 변수 선언: 주석으로, 이 줄은 변수 선언을 설명합니다.
$greeting = "안녕하세요";: $greeting이라는 변수를 선언하고 "안녕하세요"라는 문자열을 저장합니다.
echo $greeting;: $greeting 변수의 내용을 출력합니다.

4. 실전 활용 예제

예제 1: 쇼핑몰 장바구니 기능

<?php
// 장바구니 배열 초기화
$cart = array(); // 장바구니 배열을 생성합니다.

// 장바구니에 상품 추가
function addToCart($item) {
    global $cart; // 전역 변수 사용
    $cart[] = $item; // 상품을 장바구니에 추가합니다.
}

// 상품 추가
addToCart("사과");
addToCart("바나나");

// 장바구니 출력
print_r($cart); // 현재 장바구니 내용을 출력합니다.
?>

상황 설명: 쇼핑몰에서 장바구니에 상품을 추가하고, 현재 장바구니 내용을 출력하는 코드입니다.

예제 2: 사용자 로그인 처리

<?php
// 사용자 인증 함수
function authenticateUser($username, $password) {
    // 사용자 정보 확인
    if ($username = "admin" && $password = "1234") {
        return true; // 인증 성공
    }
    return false; // 인증 실패
}

// 로그인 시도
if (authenticateUser("admin", "1234")) {
    echo "로그인 성공";
} else {
    echo "로그인 실패";
}
?>

상황 설명: 사용자가 입력한 로그인 정보를 확인하고 성공 여부를 출력하는 코드입니다.

5. 흔한 실수와 주의사항

실수 1: 주석을 너무 과하게 작성하기

잘못된 코드:

// 이 코드는 변수를 선언합니다.
// 이 코드는 변수를 선언합니다.
// 이 코드는 변수를 선언합니다.
$var = 10;

올바른 코드:

// 변수 선언
$var = 10;

설명: 주석은 간결하고 필요한 부분에만 작성해야 합니다.

실수 2: 일관되지 않은 코드 스타일

잘못된 코드:

function test()
{
echo "테스트"; // 출력
}

올바른 코드:

function test() {
    echo "테스트"; // 출력
}

설명: 함수의 여는 중괄호 {는 같은 줄에 두는 것이 일반적인 코드 스타일입니다.

6. 정리

주석은 코드의 의도를 설명하는 중요한 요소입니다.
코드 스타일은 가독성을 높여 협업을 용이하게 합니다.
주석과 코드 스타일은 모두 유지보수에 큰 영향을 미칩니다.

다음에 학습하면 좋은 주제:

PHP의 기본 문법
함수와 클래스
PHP의 오류 처리 방법

학습