Re: Q: Wie dokumentiert Ihr Eure Änderungen im Sourcecode

Tech-Archive recommends: Repair Windows Errors & Optimize Windows Performance

Martin Richter [MVP] wrote:
Manchmal ist es ziemlich nützlich allgemeine Änderungen im Sourcecode
allgemein im Header oder am Ende der Datei zu dokumentieren.

Also zum Kontext: wenn ich soetwas mache, dann meistens um zu sagen dass
hier eine AEnderung stattgefunden hat welche u.U. in Zukunft
beruecksichtigt werden muss. Beispiel:

// Converted the length to floating point. This obviously breaks
// encoding the colour in the lowest bit, which has to be taken into
// account when reviving the custom version for Umbrella Corp.
// 2008-03-25 - Uli


Aktuell wird bei uns am Dateiende ein neuer Textblock der nachfolgenden
Form hinzugefügt.

//
// 2008-03-27 mri:
// Ver. 1.10.234
// Some documentation maybe with reference to the
// bugtracking system.
// And some more documentation about the changed issues.
//

Tja, also um ehrlich zu sein halte ich sowas fuer sinnlos. Wenn man sowas
braucht um den Code zu verstehen dann wage ich zu behaupten dass der Code
nicht ausreichen verstaendlich ist also besser strukturiert oder
dokumentiert werden muss. Wenn ich damit sagen will dass dieses File die
Version X.Y hat, dann wuerde ich einfach nur eine ID einfuegen anhand derer
das File mit seiner Historie in der Quellcodeverwaltung gefunden werden
kann.


Anmerkung: Am liebsten hätte ich eine "Keyword Expansion" im TFS ähnlich
VSS gehabt. Dann hätte ich Workitems und Checkin Anmerkungen direkt
mit einbauen können. Aber die gibt es nicht.

Naja, wenn das einem nur die History aus der Quellcodeverwaltung wiedergibt
sind die zusaetzlichen Informationen gleich Null, nur dass Entwicklerzeit
drauf geht sie einzufuegen und zu pflegen. Wir haben hier in eigentlich
allen Files die URL und Revisionsnummer, anhand derer man ein File
identifizieren kann, und die werden von Subversion auch automatisch auf
Stand gehalten.

Uli

--
FAQ : http://www.mpdvc.de

Sator Laser GmbH
Geschäftsführer: Michael Wöhrmann, Amtsgericht Hamburg HR B62 932
.

Relevant Pages

  • Re: Problemfall: Riesige Textmengen sortieren
    ... Es gibt allerdings noch viele Möglichkeiten den Code zu verbessern und zu beschleunigen. ... public SimpleGenerator(int length, String characters) { ... private final File tmpDir = new File; ... public void generatethrows IOException { ...
    (de.comp.lang.java)
  • Re: =?iso-8859-1?Q?Anf=E4ngerfrage=3A?= String unbekannter =?iso-8859-1?Q?Gr=F6=DFe=
    ... char * readline (FILE * fp) ... ueblichen scoping-Regeln gehorchen, was Makros nicht tun. ... leichter fuer das Auge zu erfassen. ... Es macht den Code optisch komplizierter. ...
    (de.comp.lang.c)
  • Re: Wo Oszilloskop Rigol DS1052e kaufen
    ... Ueber File Name sicher nicht, die sind codiert und der Code hat nichts mit dem Inhalt der Files zu tun. ... Ueber Brain geht es, aber es kommt darauf an ob das spaeter am Abend vor oder nach dem Glas Guinness geschieht. ...
    (de.sci.electronics)
  • Re: D2010: TZipMaster19 und Programmcrash
    ... War der Code, um das File leer anzulegen, wenn die Adds nicht ausgeführt werden und somit das File nicht angelegt. ... fTempDirectory und fZipFilename sind Strings. ... siehe anderes Posting ...
    (de.comp.lang.delphi.misc)
  • =?iso-8859-1?Q?Frage:_...nicht_zul=E4ssig=2C_da_die_Klasse_=22System.Web.?= =?iso-8859&#
    ... Kann mir bitte jemand helfen und sagen was ich mit dieser Fehlermeldung anfangen soll? ... dass ich die Zeile im Code behind File wie folgt ändern muss: ... Der Inhalt der Datei TreeEvents.designer.cs: ... // This code was generated by a tool. ...
    (microsoft.public.de.german.entwickler.dotnet.asp)