주석 // /**/ ///

◆ [주석의 종류]

주석의 종류에는 한줄 주석(//), 여러줄 주석(/**/), 자동완성 주석(///)이 있습니다. 

자동완성 주석은 사용하고자 하는 함수의 이름 위에 /// 를 치면 자동으로 입력됩니다.

 

◆  [주석 단축키]

맥에서는 Command + /

윈도우에서는 Ctrl + /

 

◆ 자동 완성 주석(XML 주석)

🔹 자동 완성 기능 활용 방법

1. /// 입력 후 엔터(Enter) 를 누르면 자동 완성 기능이 활성화됨.
2. <summary>, <param>, <returns>, <exception> 같은 태그를 자동으로 생성.
3. 마우스를 올리면 툴팁으로 설명이 표시됨.

🔹 주요 XML 주석 태그 정리

태그 설명

<summary>	메서드, 클래스 등의 간단한 설명
<param>	메서드의 매개변수 설명
<returns>	반환 값 설명
<exception>	발생할 수 있는 예외 정보
<remarks>	추가적인 설명
<example>	사용 예제 제공

 

예시

using System;

/// <summary>
/// 계산기 기능을 제공하는 클래스입니다.
/// </summary>
public class Calculator
{
    /// <summary>
    /// 두 개의 정수를 더합니다.
    /// </summary>
    /// <param name="a">첫 번째 정수</param>
    /// <param name="b">두 번째 정수</param>
    /// <returns>두 정수의 합</returns>
    public int Add(int a, int b)
    {
        return a + b;
    }

    /// <summary>
    /// 두 개의 정수를 나눕니다.
    /// </summary>
    /// <param name="a">나뉨수 (분자)</param>
    /// <param name="b">나눌 수 (분모, 0이 될 수 없음)</param>
    /// <returns>나눈 결과</returns>
    /// <exception cref="DivideByZeroException">b가 0일 경우 예외 발생</exception>
    public double Divide(int a, int b)
    {
        if (b == 0)
            throw new DivideByZeroException("0으로 나눌 수 없습니다.");

        return (double)a / b;
    }
}