Kennt jemand einen Editor und/oder ein Dokumentationssystem, welches es
erlaubt, beim Entwickeln mit VHDL an irgendeiner Stelle im Code - z.B.
bei der Signaldeklaration - einen Erklärtext zu hinterlegen, der dann
bei Bedarf eingeblendet wird, wenn man an anderer Stelle im Code auf das
Signal klickt?
Die Idee kam mir, als ich den pop-up - Erklärtext vom Xilinx Editor sah:
Geht man mit der Maus über ein Signal, dann blendet der Editor schon mal
das "downto" ein. Es wäre gut, wenn man noch einen Erklärtext hätte, die
mit eingeblendet würde.
Gibt es so einen Editor irgendwo, der das kann? Gfs für C++, den man
umschreiben oder erweitern könnte? Ließe sich das mit Notepad++
irgendwie managen?
-----------------------------------------------------------------------
Als zweite Frage wäre erörtern, wie man so einen Text mit in die
Qualitäts-Doku bekommt, z.B. mit Doxygen oder einer anderen SW. Mit Doxy
kann man zumindest bei C++ Textbausteine einbinden, die dann in der Doku
erscheinen. Es wäre gut, das auch bei VHDL zu haben. Momentan
unterstützt Dody das VHDL leider nicht ausreichend.
Falls es das nicht gibt:
Wer kennt sich mit der plugin-Entwicklung von Notepad++ aus? Es gibt
dort einige Code-Analysetools, die Text-Funktionen haben, also sollte
sich das im Prinzip machen lassen. Ich stelle mir so etwas vor: ("&$&"
signalisiert dem Editor einen folgenden Erklärtext)
1 | signal holli_polli_5_ena : std_logic_vector(15 downto 0) := (others => '0'); -- &$& "Enable für den 5. Polli-Eingang im Modul holli, momentan oberste 4 Bits Null"
|
2 | signal schnulli_back_clk : std_logic_vector( 3 downto 0) := (others => '0'); -- &$& "4 Eingangstakte für die Schnullifunktion, mit Clock-Mux ausgewählt"
|
3 | signal schnuili_back_out : std_logic; -- &$& "der passend zur selektierten Hardware ausgewählte Schnulli-Takt"
|
Ein Klick auf eine Funktionstaste oder Verweilen auf dem Signal blendet
das dann ein. Wenn man dann mal Tausende Signale hat und im alten Code
sucht, hat man sofort alle Infos, wie es gedacht war, was es macht und
wie man weiter machen muss.
Später genügt ein Export und man bekommt eine Liste der Signale oder
eine VHDL-Code-Version, die es in ein DOXY-Format übersetzt.