프로그래밍 언어별 주석 처리 방법 총정리

프로그래밍 언어 및 SQL 계열 언어들의 주석(Comment) 처리 방법을 정리한 문서입니다.

1. Java

대표 사용 분야: Spring Boot, Android, Enterprise Backend

한 줄 주석

// 한 줄 주석
System.out.println("Hello");

여러 줄 주석

/*
여러 줄 주석
설명 작성 가능
*/

문서 주석(JavaDoc)

/**
 * 사용자 정보를 조회합니다.
 * @param id 사용자 ID
 * @return 사용자 정보
 */
public User getUser(Long id) {
    return null;
}

공식 문서: https://docs.oracle.com/javase/specs/

---

2. JavaScript

대표 사용 분야: Frontend, Node.js, React, Vue

한 줄 주석

// 한 줄 주석
console.log("hello");

여러 줄 주석

/*
여러 줄 주석
*/

JSDoc 주석

/**
 * 사용자 생성 함수
 * @param {string} name
 */
function createUser(name) {

}

공식 문서: https://developer.mozilla.org/

---

3. Python

대표 사용 분야: AI, 데이터 분석, 자동화, 웹 백엔드

한 줄 주석

# 한 줄 주석
print("hello")

여러 줄 설명 문자열

"""
여러 줄 설명
문서화 가능
"""

Docstring

def get_user():
    """
    사용자 조회 함수
    """
    pass

공식 문서: https://docs.python.org/3/

---

4. C 언어

한 줄 주석

// 한 줄 주석
printf("hello");

여러 줄 주석

/*
여러 줄 주석
*/

공식 문서: https://www.iso.org/standard/74528.html

---

5. C++

한 줄 주석

// 한 줄 주석
std::cout << "hello";

여러 줄 주석

/*
여러 줄 주석
*/

Doxygen 문서 주석

/**
 * 사용자 클래스
 */
class User {

};

공식 문서: https://isocpp.org/

---

6. C#

대표 사용 분야: .NET, Unity

한 줄 주석

// 한 줄 주석
Console.WriteLine("hello");

여러 줄 주석

/*
여러 줄 주석
*/

XML 문서 주석

/// 사용자 조회
/// <summary>
/// 사용자 정보 반환
/// </summary>

공식 문서: https://learn.microsoft.com/dotnet/csharp/

---

7. PHP

한 줄 주석

// 한 줄 주석

# 한 줄 주석

여러 줄 주석

/*
여러 줄 주석
*/

PHPDoc

/**
 * 사용자 조회
 */
function getUser() {

}

공식 문서: https://www.php.net/docs.php

---

8. Go

한 줄 주석

// 한 줄 주석
fmt.Println("hello")

여러 줄 주석

/*
여러 줄 주석
*/

GoDoc

// GetUser 사용자 조회 함수
func GetUser() {

}

공식 문서: https://go.dev/doc/

---

9. Kotlin

한 줄 주석

// 한 줄 주석
println("hello")

여러 줄 주석

/*
여러 줄 주석
*/

KDoc

/**
 * 사용자 조회
 */
fun getUser() {

}

공식 문서: https://kotlinlang.org/docs/home.html

---

10. Swift

한 줄 주석

// 한 줄 주석
print("hello")

여러 줄 주석

/*
여러 줄 주석
*/

Swift 문서 주석

/// 사용자 생성 함수
func createUser() {

}

공식 문서: https://swift.org/documentation/

---

11. SQL

대표 DB: MariaDB, MySQL, Oracle, PostgreSQL

한 줄 주석

-- 한 줄 주석

SELECT * FROM users;

MySQL 스타일 주석

# 한 줄 주석
SELECT * FROM users;

여러 줄 주석

/*
여러 줄 주석
*/
SELECT * FROM users;

공식 문서: https://dev.mysql.com/doc/

---

12. Shell Script (Bash)

한 줄 주석

# 한 줄 주석
echo "hello"

여러 줄 처리 방식

: '
여러 줄 주석처럼 사용
'

공식 문서: https://www.gnu.org/software/bash/manual/

---

13. HTML

HTML 주석

<!-- HTML 주석 -->

<div>내용</div>

공식 문서: https://html.spec.whatwg.org/

---

14. CSS

CSS 주석

/* CSS 주석 */

body {
    margin: 0;
}

공식 문서: https://www.w3.org/Style/CSS/

---

15. XML

XML 주석

<!-- XML 주석 -->

<user>
    <name>admin</name>
</user>

공식 문서: https://www.w3.org/XML/

---

16. 실무 주석 작성 권장 사항

항목	설명
왜(Why)를 작성	코드 목적과 이유 중심으로 작성
불필요한 주석 지양	코드만 봐도 알 수 있는 설명 제거
TODO 사용	향후 작업 내용 명시
FIXME 사용	수정 필요 코드 표시
문서 주석 활용	API 문서 자동화 가능

---

17. TODO / FIXME 예제

// TODO: 로그인 실패 횟수 제한 추가

// FIXME: SQL Injection 방어 처리 필요

 

 

#주석처리
#Comment
#ProgrammingComment
#JavaComment
#PythonComment
#SQLComment
#JavaScriptComment
#HTMLComment
#CSSComment
#C언어주석
#SpringBoot
#Developer
#코딩기초
#프로그래밍언어
#SQL기초