SQL 코멘트 헤더 예제

Question

스토어드 프로 시저/함수 등의 주석 헤더가 어떻게 보이는지 (그래서 예제를 게시하십시오) ... 나는 SQL Server Management Studio가 무엇을 만드는지 실제로 보았지만 무엇에 관심이 있는지 다른 사람들은 ... 형식, 사용되는 문자, 절차 정보/세부 사항 등처럼 나는 ... 정말 그들이 다른 점은 무엇

SQL Server Management Studio를 (버전 9) 저장 프로 시저 코멘트 헤더 기본 추측 :

-- ============================================= 
-- Author:  Name 
-- Create date: 
-- Description: 
-- ============================================= 

Answer 1

내가 지적 할 수있는 모든 "역사를 바꿀"와 "수정 한 날짜"필드는 오히려 것보다, 버전 관리 소프트웨어에서 얻을 수 있어야 할 수 있습니다 프로그래머가 코드에 포함합니다. 이것은 C (예를 들어) 프로그래머가 오래전에 배웠던 소손입니다. 이 귀하의 요구 사항에 맞는 경우

Answer 2

우리는 이와 같은 것을 사용하며 나에게 매우 유용합니다.

/* 
Description: 
Author: 
Create Date: 
Param: 
Return: 
Modified Date: 
Modification: 
*/ 

Answer 3

-- [why did we write this?] 
-- [auto-generated change control info] 

Answer 4

/****************************** 
** File:  
** Name: 
** Desc: 
** Auth: 
** Date: 
************************** 
** Change History 
************************** 
** PR Date  Author Description 
** -- -------- ------- ------------------------------------ 
** 1 01/10/2008  Dan  added inner join 
*******************************/ 

Answer 5

-- 
-- STORED PROCEDURE 
--  Name of stored procedure. 
-- 
-- DESCRIPTION 
--  Business description of the stored procedure's functionality. 
-- 
-- PARAMETERS 
--  @InputParameter1 
--   * Description of @InputParameter1 and how it is used. 
-- 
-- RETURN VALUE 
--   0 - No Error. 
--  -1000 - Description of cause of non-zero return value. 
-- 
-- PROGRAMMING NOTES 
--  Gotchas and other notes for your fellow programmer. 
-- 
-- CHANGE HISTORY 
--  05 May 2009 - Who 
--  * More comprehensive description of the change than that included with the 
--   source code commit message. 
-- 

Answer 6

-- Author: 
-- 
-- Original creation date: 
-- 
-- Description: 

Answer 7

참조 :

/*

• Notes on parameters: Give the details of all parameters supplied to the proc

• This procedure will perform the following tasks: Give details description of the intent of the proc

• Additional notes: Give information of something that you think needs additional mention, though is not directly related to the proc

• Modification History: 07/11/2001 ACL TICKET/BUGID CHANGE DESCRIPTION

*/

Answer 8

우리는 현재 다음과 같습니다를 사용하는 헤더 : 보조 노트에

--------------------------------------------------- 
-- Produced By : Our company 
-- URL  : www.company.com 
-- Author  : me 
-- Date  : yesterday  
-- Purpose  : to do something 
-- Called by  : some other process 
-- Modifications : some other guy - today - to fix my bug 
------------------------------------------------------------ 

, 나는 SQL 내에서 발생하는 의견 나는 항상 다음 형식을 사용합니다 :

/* 논평 */

과거에는 SQL Server의 스크립트 작성이 재미있는 작업을 수행하는 데 문제가있었습니다 (필수 SQL을 주석 처리했습니다 ...).

Answer 9

set timing on <br> 
set linesize 180<br> 
spool template.log 

/*<br> 
##########################################################################<br> 
-- Name : Template.sql<br> 
-- Date    : (sysdate) <br> 
-- Author   : Duncan van der Zalm - dvdzalm<br> 
-- Company   : stanDaarD-Z.nl<br> 
-- Purpose   : <br> 
-- Usage  sqlplus <br> 
-- Impact :<br> 
-- Required grants : sel on A, upd on B, drop on C<br> 
-- Called by  : some other process<br 
##########################################################################<br> 
-- ver user date  change <br> 
-- 1.0 DDZ 20110622 initial<br> 
##########################################################################<br> 
*/<br> 

sho user<br> 

select name from v$database; 

select to_char(sysdate, 'Day DD Month yyyy HH24:MI:SS') "Start time" 
from dual 
; 


-- script 


select to_char(sysdate, 'Day DD Month yyyy HH24:MI:SS') "End time" 
from dual 
; 

spool off 

Answer 10

------------------------------------------------------------------------------- 
-- Author  name 
-- Created  date 
-- Purpose  description of the business/technical purpose 
--    using multiple lines as needed 
-- Copyright © yyyy, Company Name, All Rights Reserved 
------------------------------------------------------------------------------- 
-- Modification History 
-- 
-- 01/01/0000 developer full name 
--  A comprehensive description of the changes. The description may use as 
--  many lines as needed. 
------------------------------------------------------------------------------- 

Answer 11

는 여기에 내가 현재 무엇을 사용합니다. 트리플 주석 (/ */*/*)은 객체 정의에서 헤더 주석을 선택하는 통합을위한 것입니다.

/*/*/* 

    Name:   pr_ProcName 
    Author:   Joe Smith 
    Written:  6/15/16 
    Purpose:  Short description about the proc. 

    Edit History: 6/15/16 - Joe Smith 
         + Initial creation. 
        6/22/16 - Jaden Smith 
         + Change source to blahblah 
         + Optimized JOIN 
        6/30/16 - Joe Smith 
         + Reverted changes made by Jaden. 

*/*/*/