Should I document overloaded operators in C#?

Question

So I have been working on a C# Matrix library. I've been documenting it really good so far.

The thing is I don't know if I should document my overloaded operators, I mean, it is kind of obvious, isn't it?

Sample code:

public static Matriz operator *(Matriz A, Matriz B)
{
    if (A.map.GetLength(1) != B.map.GetLength(0))
        throw new ArgumentException("A[j] não é igual a B[i]");

    float[,] _map = new float[A.map.GetLength(0), B.map.GetLength(1)];

    for (int i = 0; i < A.map.GetLength(0); i++)
    {
        for (int j = 0; j < B.map.GetLength(1); j++)
        {
            _map[i, j] = 0;
            for (int z = 0; z < A.map.GetLength(0); z++)
            {
                _map[i, j] += A.map[i, z] * B.map[z, j];
            }
        }
    }

    return new Matriz(_map);
}

Answer 1

The thing is I don't know if I should document my overloaded operators, I mean, it is kind of obvious, isn't it?

Simple answer:

Then it won't take you very long to document it, will it? Just do it!

Complicated answer:

You're writing this documentation for someone to use, not for its own sake. Who are you writing it for? How are they going to use it? What is their opinion on what makes quality documentation?

Answer 2

An hour of commenting your code saves a week for those trying to add a feature to an existing code. I haven't seen overly-documented code aside from textbook examples.

The thing is I don't know if I should document my overloaded operators, I mean, it is kind of obvious, isn't it?

It can be obvious. To the author. For a year. But think about newcomers that are going to add features to your code. It is not that obvious to them. They are unfamiliar with our style. They might not know some language features.

---

Here is a Java example: The style of old and new parts is notably different. For instance, older code uses anonymous inner classes, while newer code relies on lambdas. Feels like a mix of Latin and modern Italian.
Programmers with different skill levels and preferences have very different styles.
GUI labels are not hard-coded (which is good), but are stored in several places for historical reasons. So, you can't search a project for a label text.
Comments a minimal.

In this situation it takes several hours just to get to the class, dealing with an element that you want to modify.