FPGA mit VHDL
VHDL-Datei-Header für Synthese-Dateien
Die Dokumentation gerade bei VHDL-Projekten ist sehr wichtig.
Eine VHDL-Datei ist letztendlich wie eine Quelldatei für Programmiersprachen zu sehen.
Die eigene Lesbarkeit nach einer Projektwiederaufnahme, die Nutzbarkeit für andere Entwickler und die Wiederverwendbarkeit in anderen Projekten sind eigentlich die wichtigsten Randbedingungen für einen sehr guten Quelltext.
Damit einher geht, dass ein Quelltext schnell und einfach zu erfassen sein muss.
Schon im Dateikopf muss erkenntlich sein, um welches Projekt und um welche Funktion es sich hierbei handelt.
Ebenfalls sollte neben der Urheberschaft auch eine Revisionsliste angelegt werden. Dies ist dahin gehend hilfreich, dass ersichtlich wird, welche Änderungen vorgenommen wurden und von wem.
Beispiel eines Datei-Headers für Synthese-Dateien
Den nachfolgenden Vorschlag können Sie mit der Maus markieren und in Ihr Dokument einfügen.
Die komplette Vorlage für VHDL-Quelltexte kann auch downgeloaded werden.
-- *************************************************
-- = ==
-- * | | /*
-- ** ------- * | |/ *
-- * *====| |====| | | |
-- ** ------- * | |\ *
-- * | | \*
-- ELEKTRONIK = ==
-- ENTWICKLER
-- AACHEN
--
-- Adresse:
-- F.Juergen Gensicke, Dipl.-Ing. (FH)
-- Kirberichshofer Weg 31, D-52066 Aachen
--
-- Tel.: +49 / 241 / 47580488
-- Mobil: +49 / 173 / 2931531
-- *************************************************
-- Entwickelt fuer:
--
-- Firmennamen
--
-- Adresse:
-- Firma
-- Ansprechpartner
-- Strasse, D-PLZ Ort
--
-- Tel.: +49 / Vorwahl / Anschluss
-- Mobil: +49 / Vorwahl / Anschluss
-- E-Mail: E-Mail-Adresse
-- *************************************************
-- Datei: Dateinamen.vhd
-- Autor: F.Juergen Gensicke
-- Datum: 23.01.2011
-- *************************************************
-- Beschreibung :
--
--
-- Revisionen:
-- =============================
-- Aenderung am DATUM Version X:
-- Autor: F.Juergen Gensicke
-- Was?:
-- Text mit Aenderungsbeschreibung
-- Design Goal: Timing
-- Strategie: Performance with IO Packaging
-- *************************************************
-- Libraries:
library IEEE;
use IEEE.STD_LOGIC_1164.ALL;
use IEEE.STD_LOGIC_UNSIGNED.ALL;v
Library UNISIM;
use UNISIM.vcomponents.all;
-- *************************************************