Details
-
Suggestion
-
Resolution: Unresolved
-
Not Evaluated
-
None
-
Qt Creator 17.0.0-beta1
-
None
Description
The annotation next to the incoming and outgoing methods should only contain namespace and class name.
I find it confusing, that the method name is repeated in the annotation.
When I look at the annotation I'm interested in
- the class, where this method lives in
- and the namespace where this class lives in.
With the repetition of the method name I have to look very close, what the class name is:
If I remove the method names, I think it is easier to read:
With Namespace it would look like this:
There one could also discuss, if a formatting of:
printAddress MyFloat - MM
would be easier to read:
printAddress is a method of MyFloat in the namespace MM
I think this would also be beneficial, if you are using namespace hierarchies:
printAddress MyFloat - MM::Foo::Bar
would read:
printAddress is a method of MyFloat in the namespace MM::Foo::Bar