Как правильно ссылаться на не перегруженные операторы в документации? - PullRequest
Новая
       39

Как правильно ссылаться на не перегруженные операторы в документации?

0 голосов
/ 16 апреля 2020

У меня есть класс, который перегружает операторы true, false, & и |, , что позволяет использовать операторы && и ||.

Все работает как надо, но у меня небольшая проблема с XML документацией этого класса.

С помощью этот ответ и этот ответ Мне удалось сослаться на перегруженные операторы, которые я перегружал, в документации класса: 

    /// <summary>
    /// ...
    /// The ... class overloads the <see cref="op_True"/>, <see cref="op_False"/>, 
    /// <see cref="op_BitwiseAnd"/> and <see cref="op_BitwiseOr"/> 
    /// operators to make it easy to use in validatios.
    /// The <see cref="op_BitwiseAnd"/> operator returns the first failed operand (or the last operand tested),
    /// and the <see cref="op_BitwiseOr"/> operator returns the first succeesfull operand (or the last operand tested).
    /// Since the <see cref="op_True"/>, <see cref="op_False"/> operators 
    /// are also overloaded, &amp;&amp; and || operators can be used to short-circuit.
    /// </summary>
    public class ...

Официальная документация тега <see cref="..."> гласит следующее:

Полный набор имен функций бинарных операторов выглядит следующим образом: op_Addition, op_Subtraction, op_Multiply, op_Division, op_Modulus, op_BitwiseAnd, op_BitwiseOr, op_ExclusiveOr, op_LeftShift, op_RightShift, op_Equality, op_TealTeal_RealEhality. Op.

Из этой документации (а также моих попыток) нет способа использовать <see cref="..."> для && и || операторы (которые op_LogicalAnd и op_LogicalOr согласно этого ответа ).

Так что есть лучший способ, чем записывать их вручную в XML (&amp;&amp; и ||) как я уже сделал?

...