산업 제조
산업용 사물 인터넷 | 산업자재 | 장비 유지 보수 및 수리 | 산업 프로그래밍 |
home  MfgRobots >> 산업 제조 >  >> Industrial programming >> C 언어

C 언어 주석 마스터하기: 명확하고 효과적인 주석 작성법

C 언어에서 주석(Comment)이란?

주석은 소스 코드에 동반되는 설명이나 기술입니다. 개발자가 의도를 전달하고, 가독성을 높이며, 시간이 지나도 코드를 유지보수하기 쉽게 돕습니다. 컴파일 과정에서 컴파일러는 주석을 단순히 무시하므로 런타임 성능에 전혀 영향을 주지 않습니다.

C에는 두 가지 표준 스타일이 있습니다:

  1. 블록 주석: /*로 시작해 */로 끝납니다. 한 줄 또는 여러 줄에 걸쳐 쓸 수 있습니다.
  2. 한 줄 주석: //로 시작합니다. 해당 줄의 두 슬래시 뒤 모든 내용은 컴파일러에 의해 버려집니다.

한 줄 주석 예시

// 이것은 한 줄 주석입니다 

아래는 한 줄 주석 사용을 보여주는 최소 프로그램입니다:

#include <stdio.h>
int main(void) {
    // 다음 줄은 인사말을 출력합니다
    printf("Guru99");
    return 0; // 종료 상태
} 

여러 줄 주석 예시

/* 샘플 여러 줄 주석
1행
2행
... */ 

블록 주석과 인라인 한 줄 주석을 혼합한 실제 예시:

#include <stdio.h>
int main() {
    /* main 함수에서
       로직을 설명하고 핵심 단계를 강조합니다 */
    int x = 42; // x는 정수 변수
    printf("%d", x);
    return 0;
} 

왜 주석을 달아야 하는가?

인간이 읽기 쉬운 코드를 작성하는 것은 전문 소프트웨어 개발의 초석입니다. 주석은:

규칙적인 주석 습관은 업계 모범 사례로, 전문성, 성실함, 품질에 대한 의지를 보여줍니다.

C 언어

  1. C# 주석 마스터하기: 종류, 모범 사례, XML 문서화
  2. C# 네임스페이스 마스터하기: 구성, 범위, 모범 사례
  3. C++ 주석: 가독성 높고 유지보수하기 좋은 코드 작성법
  4. C 프로그래밍 연산자 완벽 가이드
  5. Java 주석: 종류, 사용법, 모범 사례
  6. VHDL TEXTIO 라이브러리로 텍스트 파일에서 FPGA 블록 RAM 초기화하기
  7. C 프로그래밍 입문: 시스템 프로그래밍의 기초 다지기
  8. C++ 주석 마스터하기: 모범 사례와 문법
  9. 산업 생산라인 유지보수 마스터: 최고 생산성을 위한 팁
  10. 로봇 프로그래밍 이해: 3가지 주요 방법 설명