Sollte ich den Namen des Autors in der Klassendatei ändern, wenn ich mehr als 80% ige Änderungen vornehme?

Ich überarbeite die vorhandenen Java-Testklassen für automatisierte UI-Tests. Manchmal ändere ich die Klassendatei massiv oder überarbeite sie komplett. Das lässt mich denken, dass ich, wenn ich die gesamte Klasse umschreibe, den Namen des Autors im Kommentarbereich in meinen ändern soll?

Bin ich gierig? oder ist es sinnvoll, meinen namen zu sehen und mich im zweifel zu fragen?

Es kommt wirklich darauf an ...

Wenn Sie der Meinung sind, dass eine andere Person möglicherweise später daran interessiert ist, den Originalautor zu fragen, geben Sie ihren Namen im Code an. Wenn Sie der Meinung sind, dass jemand daran interessiert ist, Sie persönlich zu fragen, geben Sie Ihren Namen an. Und wenn Sie denken, dass beides möglich sein könnte, lassen Sie beide Namen ein (oder einen Kommentar wie "basierend auf der Arbeit von ...").

Wenn die Verwendung der Quellcodeverwaltung an Ihrem Arbeitsplatz obligatorisch ist und dies die einzige Möglichkeit ist, auf die Quellen zuzugreifen, sollten Sie jeden Kommentar des Autors aus der Quelle streichen. An meinem Arbeitsplatz haben wir zum Beispiel viele Quelldateien in der Quellcodeverwaltung, in die wir keine Namen schreiben müssen. Wenn ich wissen möchte, wer für die Datei verantwortlich ist, in der Vergangenheit war oder für eine bestimmte Änderung, erstellt TortoiseSVN mir einfach ein Protokoll dafür.

Auf der anderen Seite haben wir viele VBA-Makros, die von einigen Leuten geschrieben wurden, an andere weitergegeben wurden (einige von ihnen haben das Unternehmen im Laufe der Jahre verlassen) und wurden stark modifiziert, alle ohne Verwendung der Quellcodeverwaltung. Glücklicherweise enthalten Kommentare zu diesen Dateien häufig Autorennamen und eine Art Verlaufsprotokoll.

Ich bin gerade auf einen anderen Beitrag gestoßen, in dem OP gefragt hat, ob der Name des Autors überhaupt in der Dateikopfzeile stehen soll. Mindestens zwei Drittel der Befragten gaben an, dass der Name nicht einmal aufgeführt werden sollte und Sie die Versionskontrolle verwenden sollten Verfolgen Sie einfach, wer die Datei geändert hat. Ich weiß nicht, was mit diesem Beitrag passiert ist, aber jetzt kann ich ihn nicht finden. <- (daher anonymes "OP")

Persönlich finde ich den Autor, der im Dateikopf aufgeführt ist, nützlich, aber aus einem etwas anderen Grund (und dies bezieht sich möglicherweise nicht auf andere in ihrer Umgebung). Auch wenn wir versuchen, Community Ownership zu üben und häufig an verschiedenen Teilen des Projekts arbeiten, haben wir in der Regel nur wenige Teammitglieder, die bestimmte Bereiche des Codes viel besser kennen als andere. Wenn also jemand (insbesondere zahlreiche Auftragnehmer, die kommen und gehen) eine Datei öffnet, die sie noch nie gesehen haben, wird der Autor zum Ansprechpartner. Er ist möglicherweise nicht der einzige oder sogar der Mehrheitsverantwortliche, hat jedoch seinen Namen an der Spitze und gibt zu, eine gewisse Verantwortung für die Weitergabe von Wissen / Informationen über den Code an den Rest des Teams zu haben. Wir können mehr als eine Person in der Kopfzeile auflisten, wenn tatsächlich mehrere Personen beigetragen haben und sich verantwortlich fühlen.

Ich finde es frustrierend, wenn ich eine Frage zu einer Datei habe und auf die Versionskontrolle zurückgreifen muss, um die primäre oder sachkundigste Person zu identifizieren. Dann gehen sie von einem Typ zum nächsten, da sie alle bestreiten, wirklich zu wissen, was der Code tut ... sie mussten nur ein oder zwei Fehler beheben.

Diese Praxis funktioniert in unserem Team, weil wir keine Übergaben haben. Sofern eine Person nicht aufgibt oder in ein anderes Team wechselt, bleibt dieser Code / dieses Projekt bei der Person und bei unserem Team. Es ist offensichtlich, dass es niemanden interessiert, wer in der Kopfzeile aufgeführt ist, wenn Leute, die den Code verwalten, nicht mit denen identisch sind, die ihn schreiben.

In Anbetracht meiner Sicht auf Dateiköpfe würde ich sagen, wenn Sie 80% der Datei geändert haben und sich jetzt als Ansprechpartner für alle Fragen fühlen (und Sie sollten sich wahrscheinlich so fühlen), ja, gehen Sie Aktualisieren Sie den Dateiheader, damit Ihr Name darauf steht. Wenn Sie Bedenken haben, frühere Personen zu entfernen, können Sie zumindest vorerst auch deren Namen dort belassen. Sie können immer den Originalautor fragen, und ich bin mir sicher, dass es ihnen nichts ausmacht, dass Sie den Namen geändert haben, da ich davon ausgehe, dass es kein Problem ist, wenn Sie 80% der Datei selbst ändern.

UPDATE: Diesen Beitrag gefunden . Habe keine Ahnung, wie ich es geschafft habe, etwas vom August zurückzuziehen. Ich habe gerade The Pragmatic Programmer gelesen und im letzten Kapitel sprechen die Autoren über das Signieren und die Rechenschaftspflicht (der andere Beitrag erwähnte es, deshalb habe ich es nachgeschlagen). Das Buch macht vollkommen Sinn und jetzt, wo ich darüber nachdenke, sollten wir vielleicht eine Teamrichtlinie einführen, dass jeder, der als Autor aufgeführt ist, in alle Code-Überprüfungen der fraglichen Datei aufgenommen werden sollte. Egal, wer die Datei zuletzt oder am meisten in SVN geändert hat, der Autor ist der Eigentümer und der Verwalter.

Ich finde den Namen des Autors nicht besonders nützlich. Wie diese Frage zeigt, gibt es oft keinen einzelnen Autor, so dass die Nennung "des Autors" nicht möglich ist.

Sie könnten natürlich eine Liste aller Personen, die wichtige Beiträge geleistet haben, hinzufügen, aber das können Sie bereits aus dem Revisionskontrollprotokoll abrufen - also, worum geht es?

In meinem Projekt gibt es in den meisten Dateien keine Autoreninformationen. Wenn Sie eine Frage haben, schauen Sie einfach in die Protokolle und normalerweise ist es offensichtlich, dass ein oder zwei Personen den größten Teil der Arbeit erledigt haben, also fragen Sie sie.

Bearbeiten

Die Antwort geht von einem Projekt mit Versionskontrolle aus. Wenn Sie VC nicht (konsistent) verwenden, können Sie möglicherweise einen Autor (Liste) und möglicherweise einen Änderungsverlauf in eine Datei einfügen. Trotzdem sollten Sie VC wahrscheinlich so schnell wie möglich verwenden. In diesem Fall siehe oben :-).

Wenn die Datei wesentlich geändert wurde, sollte es akzeptabel sein, Ihren Namen als jemand in die Datei aufzunehmen, der etwas darüber weiß.

Der Ersteller der Quelldatei sollte / muss immer (IMHO) in der Quelldatei genannt werden. Dies sollte mit guten Kommentaren in den Überschriften zeigen, warum der Autor die Quelle entwickelt hat und wie er den Code geschrieben hat. Für den Betreuer des Codes ist das Hinzufügen des Namens des Betreuers für die Versionsverwaltungsverfolgung von entscheidender Bedeutung.

Die Nennung des Autors, IMHO wiederum, sollte die Quellversion des Codes außerhalb des Versionskontrollsystems, das erste Datum, an dem die Änderung vorgenommen wurde, sowie die Nummer der Änderungsanforderung enthalten. Der Grund ist, dass, wenn die Entscheidung zur Änderung des VCS getroffen wird, die Version des Codes, der Autor und die Nummer der Änderungsanforderung, auf die sich die Entwickler beziehen können, in der Vergangenheit vermerkt wurden (wenn sie wissen müssen, warum der Betreuer das getan hat, was er / sie getan hat). Sie tat). In unserer Organisation ist unser Format also wie folgt:

/**
 * $comment
 * <p />
 * $cr_number, $date, $author, $description 
 **/

Ich mag es, den Namen des ursprünglichen Autors zu sehen, wenn ich nur jemanden finde, der meine Suche nach Antworten über den Code startet. (Der Autor hat normalerweise keine Erinnerung, aber es ist zumindest eine Einstellung!)

Ich würde empfehlen, dass Sie einfach Ihren Namen unter dem des ursprünglichen Autors hinzufügen.

Es besteht keine Notwendigkeit, den Namen der anderen Person zu ersetzen, da diese möglicherweise einen Aspekt des ursprünglichen Geschäftsbedarfs kennt , den Sie nicht kennen, und andere, die folgen, nachdem Sie möglicherweise auch mit dieser Person sprechen müssen.

Meine Richtlinie zu @author-Kommentaren lautet:

1. Wenn es eine brandneue Datei ist, setze ich mich als @author.
2. Wenn es sich um eine vorhandene Datei handelt, lasse ich @author in Ruhe, unabhängig davon, was ich mit der Datei mache.

Wenn Sie Fragen zu etwas haben, spielt es keine Rolle, wer der @Autor der Datei ist - es ist wichtig, wer der @Autor des Teils der Datei ist, den Sie bearbeiten. Dafür [git/svn/whatever] blameist es da.

IMO, @author muss weg.