다음을 통해 공유

코드의 주석(Visual Basic)

코드 예제를 읽을 때 주석 기호(')가 자주 발생합니다. 이 기호는 Visual Basic 컴파일러에 다음 텍스트 또는 주석을 무시하도록 지시 합니다. 주석은 코드를 읽는 사람들의 이익을 위해 코드에 추가된 간단한 설명 메모입니다.

프로시저의 기능적 특성(수행하는 작업)을 설명하는 간단한 주석으로 모든 프로시저를 시작하는 것이 좋습니다. 이는 사용자 고유의 이익과 코드를 검사하는 다른 사람의 이익을 위한 것입니다. 구현 세부 정보(프로시저가 수행하는 방식)를 기능 특성을 설명하는 주석과 분리해야 합니다. 설명에 구현 세부 정보를 포함하는 경우 함수를 업데이트할 때 이를 업데이트해야 합니다.

주석은 같은 줄의 문장을 따르거나 별도의 줄에 있을 수 있습니다. 둘 다 다음 코드에 설명되어 있습니다.

' This is a comment beginning at the left edge of the screen.
text1.Text = "Hi!"   ' This is an inline comment.

주석에 둘 이상의 줄이 필요한 경우 다음 예제와 같이 각 줄에 주석 기호를 사용합니다.

' This comment is too long to fit on a single line, so we break 
' it into two lines. Some comments might need three or more lines.

댓글 작성 가이드라인

다음 표에서는 코드 섹션 앞에 표시할 수 있는 주석 유형에 대한 일반적인 지침을 제공합니다. 다음은 제안 사항입니다. Visual Basic은 주석 추가에 대한 규칙을 적용하지 않습니다. 사용자와 코드를 읽는 다른 사람을 위해 가장 적합한 항목을 작성합니다.

메모 유형 댓글 설명
목적 프로시저가 수행하는 작업(수행 방법이 아님)을 설명합니다.
가정 (전제) 프로시저에서 액세스하는 각 외부 변수, 컨트롤, 열린 파일 또는 기타 요소를 나열합니다.
효과 영향을 받는 각 외부 변수, 컨트롤 또는 파일 및 영향을 나열합니다(명확하지 않은 경우에만).
입력 인수의 용도를 지정합니다.
반품 프로시저에서 반환된 값을 설명합니다.

다음 사항을 기억하세요.

  • 모든 중요한 변수 선언 앞에 선언되는 변수의 사용을 설명하는 주석이 있어야 합니다.

  • 변수, 컨트롤 및 프로시저는 복잡한 구현 세부 정보에 대해서만 주석 처리가 필요하므로 명확하게 이름을 지정해야 합니다.

  • 주석은 같은 줄의 줄 연속 시퀀스를 따를 수 없습니다.

하나 이상의 코드 줄을 선택하고 편집 도구 모음에서 The Visual Basic Comment button in Visual Studio.The Visual Basic Comment button in Visual Studio.주석() 및 The Visual Basic Uncomment button in Visual Studio.주석 제거( 주석 제거 단추)를 선택하여 코드 블록에 대한 주석 기호를 추가하거나 제거할 수 있습니다.

비고

텍스트 앞에 키워드를 추가하여 코드에 주석을 REM 추가할 수도 있습니다. 그러나 ' 기호와 주석/주석 단추는 사용하기 쉬우며 공간과 메모리가 더 적게 필요합니다.

참고하십시오