Skip to content

Commit 12bf7ec

Browse files
gafterjskeet
andcommitted
Update standard/documentation-comments.md
Co-authored-by: Jon Skeet <[email protected]>
1 parent 3ffff34 commit 12bf7ec

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

standard/documentation-comments.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -696,7 +696,7 @@ The documentation generator observes the following rules when it generates the I
696696
- Arguments are represented by their documentation name, which is based on their fully qualified name, modified as follows:
697697
- Arguments that represent generic types have an appended “`'`” character followed by the number of type parameters
698698
- Arguments having the `in`, `out` or `ref` modifier have an `@` following their type name. Arguments passed by value or via `params` have no special notation.
699-
- Arguments that are multi-dimensional arrays are represented as `[` *lowerbound* `:` *size* `,``,` *lowerbound* `:` *size* `]` where the number of commas is the rank less one, and the lower bounds and size of each dimension, if known, are represented in decimal. If a lower bound or size is not specified, it is omitted. If the lower bound and size for a particular dimension are omitted, the “`:`” is omitted as well. Jagged arrays are represented by one “`[]`” per level. Single dimension arrays omit the lower bound when the lower bound is 0 (the default) (§17.1).
699+
- Arguments that are arrays are represented as `[` *lowerbound* `:` *size* `,``,` *lowerbound* `:` *size* `]` where the number of commas is the rank less one, and the lower bounds and size of each dimension, if known, are represented in decimal. If a lower bound or size is not specified, it is omitted. If the lower bound and size for a particular dimension are omitted, the “`:`” is omitted as well. Jagged arrays are represented by one “`[]`” per level. Single dimensional arrays omit the lower bound when the lower bound is 0 (the default) (§17.1).
700700
- Arguments that have pointer types other than `void` are represented using a `*` following the type name. A `void` pointer is represented using a type name of `System.Void`.
701701
- Arguments that refer to generic type parameters defined on types are encoded using the “`` ` ``” character followed by the zero-based index of the type parameter.
702702
- Arguments that use generic type parameters defined in methods use a double-backtick “``` `` ```” instead of the “`` ` ``” used for types.

0 commit comments

Comments
 (0)