[Amarok] Comments++

Mark Kretschmann kretschmann at kde.org
Thu Nov 12 08:19:13 CET 2009


On Thu, Nov 12, 2009 at 5:57 AM, Daniel Dewald
<Daniel.Dewald at time-shift.de> wrote:
> commit 2422f147ce4c22bfe59c05ab51d39de1e350882b
> Author:     Daniel Dewald <Daniel.Dewald at time-shift.de>
> AuthorDate: Wed Nov 4 21:25:12 2009 +0100
> Commit:     Daniel Meltzer <parallelgrapefruit at gmail.com>
> CommitDate: Wed Nov 11 23:50:36 2009 -0500

[SNIP]

> +/**
> +    @author Daniel Dewald <Daniel.Dewald at time-shift.de>
> +*/

Please don't use this "@author" comment. Instead, put your name in the
copyright headers only. If other people eventually add to the code,
the "author" thing would no longer be precise.

Instead of this, you could write a comment that explains what the
purpose of this class is.

-- 
Mark Kretschmann
Amarok Developer
www.kde.org - amarok.kde.org


More information about the Amarok-devel mailing list