Do you read comments?

BernieTheBernie

Bernie created an interface which combined some other interfaces:

public interface IAlarmCommunicator:IAlarmEventSender, IAlarmProvider, IStartAndStoppable
{
    // currently combines above interfaces only.
}

Later on, his coworker Kevin needed some more functionality. Now the interface definition is:

public interface IAlarmCommunicator:IAlarmEventSender, IAlarmProvider, IStartAndStoppable
{
    // currently combines above interfaces only.
    void Connect();

    bool IsConnected { get; }
}

Thanks, Kevin!

TheCPUWizard

@berniethebernie - How did this get past code review? Ideally, if an interface is an aggregator, then it should be tagged as such [.NET Attribute] and the test automated.

boomzilla

@thecpuwizard said in Do you read comments?:

How did this get past code review?

Ha ha ha! You kill me, man.

BernieTheBernie

Worse yet: Bernie took a look at the history of the file. And there he saw, that originally there was a typo in the comment. Someone corrected it. Guess... it was Kevin, when he added the extra property and function.

japonicus

But 'currently' invites improvement...

Could do better: The interface is currently rather sparse, but it could try harder and really make something of itself and become so much more :)

Greybeard

@berniethebernie Did Kevin also remove a yob’s comma from the comment?