PL / SQL कोड बनाना और JavaDoc के समान PL / SQL प्रलेखन (pldoc) उत्पन्न करना

टीम के अंदर, आपको अपने स्वयं के मानकों और नियमों को विकसित करने की आवश्यकता है, और कागजी कार्रवाई टीमवर्क के मुख्य नियमों में से एक है।

खैर, चलिए ...

Pldoc टूल से ही लिंक करें।

संदर्भ से सब कुछ अच्छी तरह से निर्धारित किया गया है कि कैसे काम करना है और प्रलेखन उत्पन्न करना है, लेकिन इसे आसान बनाने के लिए मैं उदाहरण और स्क्रिप्ट दूंगा।

स्थापित करें (संग्रह को अनपैक करें) और जड़ में run.bat बनाएं

rmdir /s /q "%TOMCAT_HOME%/Tomcat 7.0/webapps/plsqldoc" call ..\pldoc.bat -verbose -doctitle 'Api shema' -d '%TOMCAT_HOME%/Tomcat 7.0/webapps/plsqldoc' -url jdbc:oracle:thin:@host:port:SID -user API_DOC -password API_DOC -sql SCAPI.%%%%,API.%%%%,SALE.%%%%,BILLING_API.%%%%,BATCH.%%%%, pause 

जहां:

• -d '% TOMCAT_HOME% / Tomcat 7.0 / webapps / plsqldoc' - वह फ़ोल्डर जहाँ प्रलेखन उत्पन्न किया जाएगा;
• jdbc:oracle:thin:@host:port:SID डेटाबेस सर्वर जहां डेटा jdbc:oracle:thin:@host:port:SID है;
• -sql API। %% %% T% %%%%, SALE.A %%%%, BILLING_API। %%%%%।
  API। %%%% T% %%% - अक्षर T युक्त सभी API स्कीमा ऑब्जेक्ट लें;
  SALE.A %%%% - SALE योजना के सभी ऑब्जेक्ट लेटर T से शुरू होते हैं;
  BILLING_API। %%%% - BILLING_API स्कीमा की सभी वस्तुओं को लें;

हम नीचे दिए गए pl / sql कोड को डिजाइन करने के नियमों के अनुसार शुरू करते हैं और तैयार दस्तावेज प्राप्त करते हैं।

डिजाइन उदाहरण

पंजीकरण के लिए नियम ।
पंजीकरण के लिए नियम ।

पैकेज के लिए

 create or replace package EXAMPLE is -------------------------------------------------------------------------- -- ELEMENT PREFIX SUFFIX EXAMPLE DESCRIPTION -------------------------------------------------------------------------- -- variable v_ # v_club# All variables have to start with "v_" ends with "#" in lowercase -- in parameter in_ # in_club# All in parameters have to start with "in_" ends with "#" in lowercase -- out parameter out_ # out_club# All out parameters have to start with "out_" ends with "#" in lowercase -- in/out parameter io_ # io_club# All in/out parameters have to start with "io_" ends with "#" in lowercase -- cursor c_ # c_data# All cursors have to start with "c_" ends with "#" in lowercase -- record rec # rec_date# All records have to start with "rec_" ends with "#" in lowercase -- type t_ # t_data# All types have to start with "t_" ends with "#" in lowercase -- exception e_ # e_frod# All exceptions have to start with "e_" ends with "#" in lowercase /** *    (PL/SQL package) * @author Prigozhiy * @version 1 (29.09.2013) * @headcom */ /*    EMS */ v_esbusername varchar2(20) ; /** ,    * @author Prigozhiy * @version 2 (29.05.2013) * @param in_text#    * @param out_text#    */ procedure pr_output_text ( in_text# in varchar2, out_text# out varchar2 ); /** ,    * @author Prigozhiy * @version 1 (21.05.2013) * @param in_text#    * @return    * @deprecated <a href="EXAMPLE.html#FN_OUTPUT_TEXT_V1(VARCHAR2)">FN_OUTPUT_TEXT_V1</a> * @throws PROGRAM_ERROR ORA-06501   PL/SQL * @see #FN_OUTPUT_TEXT_V1(VARCHAR2) */ function fn_output_text ( in_text# in varchar2 ) return varchar2; /** ,    * @author Prigozhiy * @version 1 (21.05.2013) * @param in_text#    * @return    * @see (<a href="http://%20documentation/html/CONTRACT_RATEPLAN_HISTORY.READcms_cmd.html">CONTRACT_RATEPLAN_HISTORY.READ</a>) * @see (<a href="http://jira.main.by/browse/BSCSOA-87">BSCSOA-87</a>) */ function fn_output_text_v1 ( in_text# in varchar2 ) return varchar2; end EXAMPLE; create or replace package body EXAMPLE is /* Revisions: Ver Date Author Description --------- ---------- --------------- ------------------------------------ 1.0 28.05.2013 Prigozhiy Created this procedure 2.0 29.05.2013 Prigozhiy http://jira.main.by/browse/ONEC-49 */ procedure pr_output_text ( in_text# in varchar2, out_text# out varchar2 ) is begin out_text# := upper(in_text#); end; /* Revisions: Ver Date Author Description --------- ---------- --------------- ------------------------------------ 1.0 29.05.2013 Prigozhiy Created this procedure */ function fn_output_text ( in_text# in varchar2 ) return varchar2 is out_text# varchar2(100); begin out_text# := substr(upper(in_text#),1,100); return out_text#; end; function fn_output_text_v1 ( in_text# in varchar2 ) return varchar2 is out_text# varchar2(100); begin out_text# := substr(upper(in_text#),1,100); return out_text#; end; end EXAMPLE; 

फ़ंक्शन और प्रक्रिया के लिए

मैं आपको डॉकिंग के विवरण पर ध्यान देने के लिए कहता हूं, जो नाम फ़ंक्शन या प्रक्रिया के तुरंत बाद शुरू होता है:

 create or replace function get_change_rp_current_month /** ... 

 create or replace function get_change_rp_current_month /**      * @author Prigozhiy * @version 1 (30.05.2013) * @param in_coid id  * @return 0-  , 1-    * @see (<a href="http://documentation/html/CONTRACT_RATEPLAN_HISTORY.READcms_cmd.html">contract.GET_HISTORY_LAST_rateplan_date</a>) * @see (<a href="http://jira.main.by/browse/BSCSOA-87">BSCSOA-87</a>) */ ( in_coid in number ) RETURN number is v_date date; BEGIN /* Revisions: Ver Date Author Description --------- ---------- --------------- ------------------------------------ 1.0 30.05.2013 Prigozhiy Created this procedure */ v_date := contract.GET_HISTORY_LAST_rateplan_date(co_id => in_coid); if TRUNC(sysdate, 'month')> v_date then return 0; else return 1; end if; end; 

यदि आप मदद करने के लिए PL / SQL डेवलपर का उपयोग करते हैं

एक शैली में प्रारूपण

Pl_sql_beautifief_rules.br sl बनाएं। सामग्री:

 Version=1 RightMargin=80 Indent=2 UseTabCharacter=FALSE TabCharacterSize=2 AlignDeclarationGroups=TRUE AlignAssignmentGroups=TRUE KeywordCase=2 IdentifierCase=2 UseSpecialCase=FALSE ItemList.Format=1 ItemList.Align=TRUE ItemList.CommaAfter=TRUE ItemList.AtLeftMargin=FALSE EmptyLines=1 ThenOnNewLine=FALSE LoopOnNewLine=FALSE DML.LeftAlignKeywords=FALSE DML.LeftAlignItems=FALSE DML.OnOneLineIfPossible=FALSE DML.WhereSplitAndOr=TRUE DML.WhereAndOrAfterExpression=FALSE DML.WhereAndOrUnderWhere=TRUE DML.JoinSplitBeforeOn=TRUE DML.InsertItemList.Format=1 DML.InsertItemList.Align=FALSE DML.InsertItemList.CommaAfter=TRUE DML.InsertItemList.AtLeftMargin=FALSE DML.SelectItemList.Format=2 DML.SelectItemList.Align=TRUE DML.SelectItemList.CommaAfter=TRUE DML.SelectItemList.AtLeftMargin=FALSE DML.UpdateItemList.Format=2 DML.UpdateItemList.Align=TRUE DML.UpdateItemList.CommaAfter=TRUE DML.UpdateItemList.AtLeftMargin=FALSE ParameterDeclarationList.Format=1 ParameterDeclarationList.Align=TRUE ParameterDeclarationList.CommaAfter=TRUE ParameterDeclarationList.AtLeftMargin=TRUE RecordFieldList.Format=1 RecordFieldList.Align=TRUE RecordFieldList.CommaAfter=TRUE RecordFieldList.AtLeftMargin=FALSE SplitAndOr=FALSE AndOrAfterExpression=FALSE [SpecialCase] 

फिर PL / SQL Developer -> Tools - Preferences मेनू खोलें, फिर PL / SQL beautifief टैब, फिर नियम फाइल करें और फ़ाइल pl_sql_beautifief_rules.br को निर्दिष्ट करें और परिवर्तनों की पुष्टि करें।

अब हम लिखित pl / sql कोड का चयन करते हैं और मेनू संपादित करें -> PL / SQL ब्यूटिफायर पर क्लिक करके इसे एक शैली में प्रारूपित करते हैं।

टेम्प्लेट का उपयोग करें

टेम्प्लेट विंडो (विंडो सूची विंडो के पास), फिर बाईं माउस बटन न्यू टेम्प्लेट।

 /** [Description] * @author [Username = $OSUSER] * @version [Version=1.0] ([Date = $DATE])[+Depricated=" * @deprecated "][Depricated][+Param 1=" * @param "][Param 1][+Param 2=" * @param "][Param 2][+Param 3=" * @param "][Param 3][+Param 4=" * @param "][Param 4][+Param 5=" * @param "][Param 5][+Return=" * @return "][Return][+See=" * @see "][See] */