翻译PG11 comment.sgml

Author: ChenHuajun

postgresql/doc/src/sgml/ref/comment.sgml

@@ -3,7 +3,7 @@ doc/src/sgml/ref/comment.sgml
 PostgreSQL documentation
 -->
 
-<refentry id="SQL-COMMENT">
+<refentry id="sql-comment">
 <!--==========================orignal english content==========================
  <indexterm zone="sql-comment">
   <primary>COMMENT</primary>
@@ -65,8 +65,10 @@ COMMENT ON
   OPERATOR FAMILY <replaceable class="parameter">object_name</replaceable> USING <replaceable class="parameter">index_method</replaceable> |
   POLICY <replaceable class="parameter">policy_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> |
   [ PROCEDURAL ] LANGUAGE <replaceable class="parameter">object_name</replaceable> |
+  PROCEDURE <replaceable class="parameter">procedure_name</replaceable> [ ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) ] |
   PUBLICATION <replaceable class="parameter">object_name</replaceable> |
   ROLE <replaceable class="parameter">object_name</replaceable> |
+  ROUTINE <replaceable class="parameter">routine_name</replaceable> [ ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) ] |
   RULE <replaceable class="parameter">rule_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> |
   SCHEMA <replaceable class="parameter">object_name</replaceable> |
   SEQUENCE <replaceable class="parameter">object_name</replaceable> |
@@ -95,45 +97,6 @@ ____________________________________________________________________________-->
 <synopsis>
 COMMENT ON
 {
-  ACCESS METHOD <replaceable class="parameter">object_name</replaceable> |
-  AGGREGATE <replaceable class="parameter">aggregate_name</replaceable> ( <replaceable>aggregate_signature</replaceable> ) |
-  CAST (<replaceable>source_type</replaceable> AS <replaceable>target_type</replaceable>) |
-  COLLATION <replaceable class="parameter">object_name</replaceable> |
-  COLUMN <replaceable class="parameter">relation_name</replaceable>.<replaceable class="parameter">column_name</replaceable> |
-  CONSTRAINT <replaceable class="parameter">constraint_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> |
-  CONSTRAINT <replaceable class="parameter">constraint_name</replaceable> ON DOMAIN <replaceable class="parameter">domain_name</replaceable> |
-  CONVERSION <replaceable class="parameter">object_name</replaceable> |
-  DATABASE <replaceable class="parameter">object_name</replaceable> |
-  DOMAIN <replaceable class="parameter">object_name</replaceable> |
-  EXTENSION <replaceable class="parameter">object_name</replaceable> |
-  EVENT TRIGGER <replaceable class="parameter">object_name</replaceable> |
-  FOREIGN DATA WRAPPER <replaceable class="parameter">object_name</replaceable> |
-  FOREIGN TABLE <replaceable class="parameter">object_name</replaceable> |
-  FUNCTION <replaceable class="parameter">function_name</replaceable> ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) |
-  INDEX <replaceable class="parameter">object_name</replaceable> |
-  LARGE OBJECT <replaceable class="parameter">large_object_oid</replaceable> |
-  MATERIALIZED VIEW <replaceable class="parameter">object_name</replaceable> |
-  OPERATOR <replaceable class="parameter">operator_name</replaceable> (<replaceable class="parameter">left_type</replaceable>, <replaceable class="parameter">right_type</replaceable>) |
-  OPERATOR CLASS <replaceable class="parameter">object_name</replaceable> USING <replaceable class="parameter">index_method</replaceable> |
-  OPERATOR FAMILY <replaceable class="parameter">object_name</replaceable> USING <replaceable class="parameter">index_method</replaceable> |
-  POLICY <replaceable class="parameter">policy_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> |
-  [ PROCEDURAL ] LANGUAGE <replaceable class="parameter">object_name</replaceable> |
-  ROLE <replaceable class="parameter">object_name</replaceable> |
-  RULE <replaceable class="parameter">rule_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> |
-  SCHEMA <replaceable class="parameter">object_name</replaceable> |
-  SEQUENCE <replaceable class="parameter">object_name</replaceable> |
-  SERVER <replaceable class="parameter">object_name</replaceable> |
-  TABLE <replaceable class="parameter">object_name</replaceable> |
-  TABLESPACE <replaceable class="parameter">object_name</replaceable> |
-  TEXT SEARCH CONFIGURATION <replaceable class="parameter">object_name</replaceable> |
-  TEXT SEARCH DICTIONARY <replaceable class="parameter">object_name</replaceable> |
-  TEXT SEARCH PARSER <replaceable class="parameter">object_name</replaceable> |
-  TEXT SEARCH TEMPLATE <replaceable class="parameter">object_name</replaceable> |
-  TRANSFORM FOR <replaceable>type_name</replaceable> LANGUAGE <replaceable>lang_name</replaceable> |
-  TRIGGER <replaceable class="parameter">trigger_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> |
-  TYPE <replaceable class="parameter">object_name</replaceable> |
-  VIEW <replaceable class="parameter">object_name</replaceable>
-} IS '<replaceable class="parameter">text</replaceable>'
   ACCESS METHOD <replaceable class="parameter">object_name</replaceable> |
   AGGREGATE <replaceable class="parameter">aggregate_name</replaceable> ( <replaceable>aggregate_signature</replaceable> ) |
   CAST (<replaceable>source_type</replaceable> AS <replaceable>target_type</replaceable>) |
@@ -157,8 +120,10 @@ COMMENT ON
   OPERATOR FAMILY <replaceable class="parameter">object_name</replaceable> USING <replaceable class="parameter">index_method</replaceable> |
   POLICY <replaceable class="parameter">policy_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> |
   [ PROCEDURAL ] LANGUAGE <replaceable class="parameter">object_name</replaceable> |
+  PROCEDURE <replaceable class="parameter">procedure_name</replaceable> [ ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) ] |
   PUBLICATION <replaceable class="parameter">object_name</replaceable> |
   ROLE <replaceable class="parameter">object_name</replaceable> |
+  ROUTINE <replaceable class="parameter">routine_name</replaceable> [ ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) ] |
   RULE <replaceable class="parameter">rule_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> |
   SCHEMA <replaceable class="parameter">object_name</replaceable> |
   SEQUENCE <replaceable class="parameter">object_name</replaceable> |
@@ -291,6 +256,14 @@ ____________________________________________________________________________-->
     <term><replaceable class="parameter">policy_name</replaceable></term>
 ____________________________________________________________________________-->
     <term><replaceable class="parameter">policy_name</replaceable></term>
+<!--==========================orignal english content==========================
+    <term><replaceable class="parameter">procedure_name</replaceable></term>
+____________________________________________________________________________-->
+    <term><replaceable class="parameter">procedure_name</replaceable></term>
+<!--==========================orignal english content==========================
+    <term><replaceable class="parameter">routine_name</replaceable></term>
+____________________________________________________________________________-->
+    <term><replaceable class="parameter">routine_name</replaceable></term>
 <!--==========================orignal english content==========================
     <term><replaceable class="parameter">rule_name</replaceable></term>
 ____________________________________________________________________________-->
@@ -304,7 +277,7 @@ ____________________________________________________________________________-->
      <para>
       The name of the object to be commented.  Names of tables,
       aggregates, collations, conversions, domains, foreign tables, functions,
-      indexes, operators, operator classes, operator families, sequences,
+      indexes, operators, operator classes, operator families, procedures, routines, sequences,
       statistics, text search objects, types, and views can be
       schema-qualified. When commenting on a column,
       <replaceable class="parameter">relation_name</replaceable> must refer
@@ -313,7 +286,7 @@ ____________________________________________________________________________-->
 ____________________________________________________________________________-->
      <para>
       要被注释的对象的名称。表、聚集、排序方式、转换、域、外部表、函数、
-      索引、操作符、操作符类、操作符族、序列、统计信息、文本搜索对象、类型和视图
+      索引、操作符、操作符类、操作符族、存储过程、例程、序列、统计信息、文本搜索对象、类型和视图
       的名称可以被模式限定。在注释一列时，
       <replaceable class="parameter">relation_name</replaceable>必须
       引用一个表、视图、组合类型或者外部表。
@@ -387,7 +360,7 @@ ____________________________________________________________________________-->
     <listitem>
 <!--==========================orignal english content==========================
      <para>
-      The mode of a function or aggregate
+      The mode of a function, procedure, or aggregate
       argument: <literal>IN</>, <literal>OUT</>,
       <literal>INOUT</>, or <literal>VARIADIC</>.
       If omitted, the default is <literal>IN</>.
@@ -399,7 +372,7 @@ ____________________________________________________________________________-->
      </para>
 ____________________________________________________________________________-->
      <para>
-      一个函数或者聚集的参数的模式：<literal>IN</literal>、
+      一个函数，存储过程或者聚集函数的参数的模式：<literal>IN</literal>、
       <literal>OUT</literal>、<literal>INOUT</literal>或者<literal>VARIADIC</literal>。
       如果被省略，默认值是<literal>IN</literal>。注意
       <command>COMMENT</command>并不真正关心
@@ -425,7 +398,7 @@ ____________________________________________________________________________-->
      </para>
 ____________________________________________________________________________-->
      <para>
-      一个函数或者聚集参数的名称。注意
+      一个函数，存储过程或者聚集函数参数的名称。注意
       <command>COMMENT</command>并不真正关心参数名称，
       因为决定函数的身份只需要参数数据类型。
      </para>
@@ -444,7 +417,7 @@ ____________________________________________________________________________-->
      </para>
 ____________________________________________________________________________-->
      <para>
-      一个函数或者聚集参数的数据类型。
+      一个函数，存储过程或者聚集函数参数的数据类型。
      </para>
     </listitem>
    </varlistentry>
@@ -652,6 +625,7 @@ COMMENT ON OPERATOR - (NONE, integer) IS 'Unary minus';
 COMMENT ON OPERATOR CLASS int4ops USING btree IS '4 byte integer operators for btrees';
 COMMENT ON OPERATOR FAMILY integer_ops USING btree IS 'all integer operators for btrees';
 COMMENT ON POLICY my_policy ON mytable IS 'Filter rows by users';
+COMMENT ON PROCEDURE my_proc (integer, integer) IS 'Runs a report';
 COMMENT ON ROLE my_role IS 'Administration group for finance tables';
 COMMENT ON RULE my_rule ON my_table IS 'Logs updates of employee records';
 COMMENT ON SCHEMA my_schema IS 'Departmental data';
@@ -697,6 +671,7 @@ COMMENT ON OPERATOR - (NONE, integer) IS 'Unary minus';
 COMMENT ON OPERATOR CLASS int4ops USING btree IS '4 byte integer operators for btrees';
 COMMENT ON OPERATOR FAMILY integer_ops USING btree IS 'all integer operators for btrees';
 COMMENT ON POLICY my_policy ON mytable IS 'Filter rows by users';
+COMMENT ON PROCEDURE my_proc (integer, integer) IS 'Runs a report';
 COMMENT ON ROLE my_role IS 'Administration group for finance tables';
 COMMENT ON RULE my_rule ON my_table IS 'Logs updates of employee records';
 COMMENT ON SCHEMA my_schema IS 'Departmental data';