2009-07-06 14 views
46

सिर्फ देखना भी क्या लोगों संग्रहित करना चाहेंगे प्रक्रिया/कार्य आदि टिप्पणी हेडर की तरह लग रहे (ताकि आपके उदाहरण पोस्ट) ... मैं केवल वास्तव में देखा है क्या एसक्यूएल सर्वर प्रबंधन स्टूडियो बनाता है लेकिन क्या में दिलचस्पी है अन्य लोगों की तरह ... स्वरूपण, उपयोग किए गए वर्णों, प्रक्रिया जानकारी/विवरण आदि देखने मुझे लगता है कि कर रहे हैं क्या वास्तव में उन्हें अलग बनाता है ...एसक्यूएल टिप्पणी हैडर उदाहरण

एसक्यूएल सर्वर प्रबंधन स्टूडियो (संस्करण 9) संग्रहीत प्रक्रिया टिप्पणी हैडर डिफ़ॉल्ट:

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

लाइन टिप्पणियों (-) का उपयोग कभी नहीं करें, यदि आपको लाइन स्वरूपण में कोई समस्या है तो आप नरक टिप्पणी करेंगे। –

+1

क्या आप कृपया उस @ गेब्रियलगुइमारस पर विस्तृत जानकारी दे सकते हैं? मेरे पास लाइन टिप्पणियों के साथ बहुत सी स्क्रिप्ट हैं और इससे पहले इस बारे में पता नहीं था: मुझे क्या देखना चाहिए? –

+0

@ GabrielGuimarães प्रबंधन स्टूडियो एक समारोह caleld "बाहर टिप्पणी चयनित लाइनों" सभी चयनित लाइनों के लिए एक लाइन टिप्पणी पहले जोड़ता है। व्यस्त कार्य "चयनित लाइनों को अनमोलमेंट करें" सभी चयनित लाइनों से अग्रणी लाइन टिप्पणी को हटा देता है। मेरे लिए काफी अच्छा काम करता है। आपके पास क्या लाइन-स्वरूपण समस्याएं हैं? –

उत्तर

41

मैं बाहर बिंदु सकता है कि इन सभी "परिवर्तन इतिहास" और "संशोधित तिथि" के खेतों और नहीं बल्कि होने से, अपने संस्करण नियंत्रण सॉफ्टवेयर से प्राप्त किया जाना चाहिए कर सकते हैं प्रोग्रामर द्वारा कोड में एम्बेडेड। यह एक सबक है कि सी (उदाहरण के लिए) प्रोग्रामर बहुत पहले सीखा।

+3

इस पर कोई अच्छा प्रथा है? – lstanczyk

+3

मैंने कई कंपनियों को नहीं देखा जो संग्रहीत प्रक्रियाओं के साथ स्रोत नियंत्रण का उपयोग बुद्धिमानी से करते हैं। –

+5

क्या आप इस कारण को समझ सकते हैं कि सी प्रोग्रामर ने यह सबक सीखा? मेरा मानना ​​है कि आपको अपने स्रोत के शीर्षलेख और आपके स्रोत नियंत्रण टिप्पणी दोनों में रखना चाहिए जब आप प्रतिबद्ध करते हैं। मूल विवरण देखने के लिए आपकी फ़ाइल और स्रोत नियंत्रण प्रणाली के बीच कूदने के लिए लंबे समय तक समय बचाता है और यदि आप कभी भी स्रोत नियंत्रण प्रणाली स्विच करते हैं तो कम से कम आपके पास उस स्रोत में है जो स्थिर रहेगा। आप तर्क दे सकते हैं कि अब आपके पास दो स्थानों पर मेटा डेटा है, लेकिन यदि कोई डेवलपर एक तारीख को प्रतिलिपि नहीं कर सकता है तो दो स्थानों के बीच एक संक्षिप्त विवरण उन्हें एक-दूसरे से बंधे हुए हैं। – Kuberchaun

9

हम कुछ इस तरह है और मेरे लिए बहुत उपयोगी का उपयोग करें।

/* 
Description: 
Author: 
Create Date: 
Param: 
Return: 
Modified Date: 
Modification: 
*/ 
4
-- [why did we write this?] 
-- [auto-generated change control info] 
+1

बिल्कुल। दस्तावेज क्यों है उससे ज्यादा सार्थक है। हालांकि एक शुरुआत के रूप में, मैं क्यों पसंद करूंगा, साथ ही साथ कैसे। :) –

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

जब हम संग्रहीत प्रक्रिया में एक नया कोड जोड़ते हैं तो हम इसके अंत में शीर्ष पर संदर्भ जोड़ते हैं। उदाहरण के लिए: बॉक्सों से आंतरिक बॉक्स में शामिल हों * Coles.colorID = रंगों पर रंगों में शामिल हों।आईडी - पीआर # 1 –

+2

यह मुझे उस समय की याद दिलाता है जब हमने उन सभी लाइनों के अंत में "- पीआर # 1" जैसी सभी टिप्पणियों को हटाने के सामूहिक निर्णय किए थे, जहां भी हम उनके पास आए थे। उन्होंने कभी भी किसी उद्देश्य का काम नहीं किया। बदलाव के फोरेंसिक विश्लेषण, दुर्लभ उदाहरणों में जब आवश्यक हो, तो परिवर्तन नियंत्रण सॉफ्टवेयर का उपयोग करना बहुत आसान था। ब्लॉक टिप्पणियों के लिए –

+0

+1, और लॉग –

14
-- 
-- 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. 
-- 
0
-- Author: 
-- 
-- Original creation date: 
-- 
-- Description: 
0

देखें अगर यह सूट आपकी आवश्यकता:

/*

  • 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

*/

2

हैडर कि हम वर्तमान में इस तरह दिखता है का उपयोग करें:

--------------------------------------------------- 
-- 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 
------------------------------------------------------------ 

एक तरफ ध्यान दें पर, किसी भी टिप्पणी है कि मैं एसक्यूएल भीतर जगह

/* टिप्पणी */

: मैं हमेशा प्रारूप का उपयोग करें

जैसा कि अतीत में मुझे समस्याएं थीं जहां स्क्रिप्टिंग (एसक्यूएल सर्वर द्वारा) मजाकिया चीजें रैपिंग लाइनों और टिप्पणियां शुरू करती हैं - एसक्यूएल की आवश्यकता है .... लेकिन यह सिर्फ मुझे हो सकता है।

+6

"तिथि: कल" एलओएल –

4
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 
4
------------------------------------------------------------------------------- 
-- 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. 
------------------------------------------------------------------------------- 
0

यहाँ मैं वर्तमान में क्या उपयोग है। ट्रिपल टिप्पणी (/ */*/*) एकीकरण के लिए है जो ऑब्जेक्ट परिभाषा से शीर्षलेख टिप्पणियां निकालती है।

/*/*/* 

    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. 

*/*/*/ 
+0

यह एकीकरण कौन सा है? ऑफ-द-शेल्फ या कस्टम बनाया गया? – unfinishedmonkey

+0

@unfinishedmonkey कस्टम - मैंने एक ऐसी प्रक्रिया बनाई है जो पैटर्न के लिए वस्तुओं को स्कैन करती है और टिप्पणियों को एक तालिका में संग्रहीत करती है। – chazbot7

संबंधित मुद्दे