1. Bei meinen Quelltexten, die ich in Eigenregie mache:
- Ganz oben habe ich eine Zeile, die vom Editor (EMACS) immer
beim Abspeichern automatisch aktualisiert wird mit Datum,
Uhrzeit, Benutzername.
1 | // Time-stamp: "03.09.11 07:37 LCD44780.h klaus?wachtler.de"
|
- Mit besonderen Tags, die von der Versionsverwaltung
automatisch mit der Revisionsnummer etc. aktualisiert werden,
weiß ich welche ausgecheckte Version ich vor mir habe.
1 | // $Id: LCD44780.h 658 2011-09-04 05:42:15Z klaus $
|
(Muß man z.B. bei svn mit Attributen aktivieren)
- Ich schreibe bei mir immer noch eine Historie mit rein,
in der alle nennenswerten Änderungen kurz aufgeführt werden.
Dann muß man nicht mühsam über die Versionsverwaltung
herausfinden, was in etwa passiert ist.
1 | // Aenderungen:
|
2 | //
|
3 | // 23.06.2009 kw - von aussen nicht aufzurufende Funktionen static
|
4 | // gemacht:
|
5 | // lcd_data(), lcd_command(), lcd_enable()
|
6 | // - gemeinsamen Code aus lcd_command() und lcd_data()
|
7 | // in neue Funktion lcd_byte() ausgelagert
|
8 | // - Shiften und Maskieren in lcd_byte() eliminiert
|
9 | // - in lcd_set_cursor() Adressberechnung korrigiert
|
10 | // fuer blaues LCD "Blue Line" von Electronic Assembly
|
11 | // EA W204B-NLW bzw. Reichelt LCD204BBL
|
12 | //
|
13 | // 02.08.2009 kw - auf C++ umgestellt
|
14 | // - Ports und Pinnummern beim Initialisieren
|
15 | // anzugeben (anstatt fest verdrahtet)
|
16 | // - mehrere LCDs nutzbar (nur Enable muss auf
|
17 | // ...
|
- Meistens schreibe ich noch eine Art Literaturverzeichnis mit
rein, um in Kommentaren auf [1] oder [2] etc. Bezug nehmen zu
können:
1 | // [1] http://www.mikrocontroller.net/articles/AVR-GCC-Tutorial#LCD-Ansteuerung
|
2 | //
|
3 | // [2] http://www.mikrocontroller.net/topic/88543#751982
|
4 | //
|
5 | // [3] "DOTMATRIXDISPLAYS 4x40" von
|
6 | // Electronic Assembly GmbH
|
7 | // Lochhamer Schlag 17
|
8 | // D-82166 Gräfelfing
|
9 | // http://www.lcd-module.de
|
10 | ...
|
---
2. Bei den meisten Firmen, mit denen ich zu tun habe:
Nichts.
---
Häufig sieht man dann noch Angaben zu Copyright, ggf. Lizenz
(GNU etc.), so etwas brauche ich aber i.d.R. nicht.