Skip to content

Summary: Operator

Maira Wenzel edited this page Apr 23, 2019 · 2 revisions

The following table provides wording guidelines and boilerplate text for Summary sections in operator pages. For guidelines about documenting overloaded operators, see Overloaded member.

Item Wording Examples
Unary/binary operator; for example, + operator <Begin with a present-tense verb.> Unit + operator summary:
Adds a value to a Unit.
Conversion operator Converts a <Type> to a <Type>.

Note:
If one type is a primitive, use the language-neutral phrase for it.
Decimal to 32-bit integer conversion summary:
Converts a decimal to a 32-bit signed integer.