Coding Convention for Markup Languages (Microsoft SQL Server)

목차

• 주석
• 이름 지정 규칙

주석 (Comments)

주석

한 줄 또는 중첩된 주석에는 두 개의 하이픈(--)을 사용하세요. --으로 삽입된 주석은 새 줄 문자로 종료됩니다. 주석의 길이에는 제한이 없습니다. 다음 표에서는 텍스트를 주석으로 처리하거나 텍스트의 주석 처리를 제거하는 데 사용할 수 있는 바로 가기 키를 나열합니다.

주석 블록

주석은 별도의 줄 또는 Transact-SQL 문에 삽입될 수 있습니다. 여러 줄로 이루어진 주석은 /* 및 */로 표시되어야 합니다. 여러 줄로 이루어진 주석에 자주 사용되는 스타일 규칙은 첫 번째 줄을 /*로 시작하고, 후속 줄은 **로 시작하며, */로 끝나는 것입니다. 주석의 길이에는 제한이 없습니다. 주석의 중첩도 가능합니다. /* 문자 패턴이 기존 주석 내의 아무 곳에서 발생하면 중첩된 주석의 시작으로 처리되므로 */(주석 닫기 표시)가 필요합니다. 닫는 주석 표시가 없으면 오류가 생성됩니다.

주석 블록 (File Header)

• File 주석이 사용된 파일명을 확장자 포함하여 입력합니다.
• Summary 요약 정보를 입력합니다.
• Dependancy 종속성을 입력합니다.

/*============================================================================
  File:       sample.sql

  Summary:    샘플입니다.  

  Dependancy: > [master].[sys].[databases]
              < [AdventureWorks].[dbo].[DatabaseLog]
  
  Example:    EXEC [dbo].[StoredProcedure] 'a', 1000

  Version:    1.01.0
  Author:     [팀] 이름 (직책/직급)
  Date:       2019-02-26
  Updated:    2019-02-26

------------------------------------------------------------------------------
  이 파일은 Microsoft SQL Server 코드 샘플의 일부입니다.

  이 코드 샘플에 대한 자세한 내용은 자료를 참조하십시오.
============================================================================*/

참고
GitHub Microsft Repository : https://github.com/Microsoft/sql-server-samples