[공통개발] [Database] SP(Stored Procedure) 프로시져, FN(Function) 함수 주석 가이드 작성 요령, 명명 규칙

📝설계 명명 규칙 리스트

• Database
• Table
• Stored Procedure
• Object
• View
• Index
• SP (Stored Procedure)
• Function
• Constraint
• TmpTable
• Column

 

📝SP, FN 주석 가이드

/****************************************************************************************
  
. 작 성 자: 김민수
. 작 성 일: 2022-03-15
. 기능구분: BACK
. 기능설명: 주문 배송 상태 조회 (관리자 화면 전용, 실시간 조회)
. 관련기능: https://internal.docs.sample.com/pages/viewpage.action?pageId=98765432
            - 경로 예시 (ex. OMS > 주문관리 > 배송관리 > 배송 상세 팝업)
 
. 참조SP명: dbo.UP_BK_DELIVERY_STATUS
. 실행예제:
-- exec dbo.UP_BK_DELIVERY_STATUS_SELECT 'ORD20220315001', '2022-03-01'
  
*****************************************************************************************
변경내역:
 수정일자 수정구분 수정자  수정내용
=========================================================================================
2022-03-20 ITDEL-3 김민수 배송완료 상태 코드 추가
****************************************************************************************/
CREATE PROCEDURE dbo.UP_BK_DELIVERY_STATUS_SELECT
 @orderId    VARCHAR(20),    --주문ID
 @fromDate   DATETIME        --조회 시작일
AS
BEGIN
    SET NOCOUNT ON
    SET TRANSACTION ISOLATION LEVEL READ UNCOMMITTED
  
    SELECT  D.ORDER_ID,
            D.DELIVERY_COMPANY,
            D.TRACKING_NO,
            D.DELIVERY_STATUS,
            D.COMPLETE_DATE
    FROM dbo.DELIVERY_INFO D WITH (NOLOCK)
    WHERE D.ORDER_ID = @orderId
      AND D.REG_DATE >= @fromDate
      AND D.DELIVERY_STATUS <> 'C' --2022-03-20 ITDEL-3 김민수 배송취소 상태 제외
  
    SET NOCOUNT OFF
END
GO