Zuviel Werbung? - > Hier kostenlos beim SPS-Forum registrieren

Seite 2 von 2 ErsteErste 12
Ergebnis 11 bis 19 von 19

Thema: Automatische Dokomentation aus Kommentaren bei ST

  1. #11
    Registriert seit
    09.11.2007
    Ort
    Rhein Main (Darmstadt)
    Beiträge
    663
    Danke
    61
    Erhielt 112 Danke für 80 Beiträge

    Standard


    Zuviel Werbung?
    -> Hier kostenlos registrieren
    Hallo, das ist doch so etwas wie ein Lösungsweg.

    Ich hatte bisher noch nie reingeschaut, wie die CoDeSys Export Files aussehen. Das ist genau das, was ich suchte bisher.

    Da ich das brauche, versuche ich mich einmal an der Sache. Ich schreibe gerade eine Sicherheits Anwendung, die der TÜV abnehmen muss, es wird also so etwas ausführliches an Dokumentation nötig werden.

    Problem sind natürlich die LIBS, die man nicht selber erstellt hat.
    Geändert von RobiHerb (07.05.2010 um 15:52 Uhr) Grund: wie immer vertippt und erst danach gelesen
    Als Freelancer immer auf der Suche nach interessanten Projekten.
    Zitieren Zitieren Guter Hinweis  

  2. #12
    Registriert seit
    12.04.2010
    Beiträge
    300
    Danke
    22
    Erhielt 54 Danke für 52 Beiträge

    Standard

    Ausgehend von der Physical View müssten die verwendeten Funktionen aufgelistet und beschrieben werden.

    Dazu könnte der Kommentar vor der Funktionsdeklaration verwendet werden. Ob es sich jetzt um Funktionen oder FUB's handelt sollte dabei keine Rolle spielen.

    D.h Jeder Task in der Physical View würde einen eigenen Strang an Funktionsaufrufen erzeugen.

    Dieser könnte in den lokalen Libraries und globalen User Libraries beliebig tief gehen, jedoch würde sofort beim ersten Eintauchen in die B&R System Libraries stoppen.

    Bleibt für mich die Frage, was mir das wirklich bringt ? Meine Hauptprogrammierung erfolgt ja im TASK, wobei natürlich wo es Sinn macht auf Funktionen zurückgegriffen wird.

    Man müsste auf jeden Fall noch überlegen wie man beliebige Doku-Snippets aus dem Task in das Dokument reinbekommt. Dann könnte vielleicht ein zufriedenstellendes Ergebnis rauskommen ... ?
    Zitieren Zitieren So würde ich mir das wünschen ...  

  3. #13
    Sera ist offline Erfahrener Benutzer
    Themenstarter
    Registriert seit
    08.03.2010
    Ort
    BaWü
    Beiträge
    131
    Danke
    10
    Erhielt 13 Danke für 11 Beiträge

    Standard

    Also die Hirachie der Bausteinaufrufe soll ja nur ein Teil der Doku sein.
    Die im Task ausprogramierten Dinge können ja über Kommentar einfach dokumentiert werden. In diesem könnten dann Schlüsselzeichen enthalten sein, die dem Tool sagen wie es den entsprechenden Kommentar interpretieren soll.
    So könnte man bereits im Code die Struktur der Dokuteils des Tasks bestimmen.

    Sprich für Überschriften, Unterüberschriften , einfachen Text, Diagramme... seperate Schlüsselworte, die das dem Dokutool mitteilen wie es die Infos zu Interpretieren hat.

    Das sollte prizipiell nicht sooo schwierig sein. Hierzu ist nur (zumindest bei B&R) ein txt file zu analysieren ( auch wenn die endung anderst ist sind es textfiles). Das Tool müsste hier nur nach bestimmten Zeichen suchen und den daran anschließenden text entsprechend der Funktion behandeln, im einfachsten fall nur in die Doku kopieren.
    Es gibt zwar ( nun ma nur auf B&R bezogen) noch Dinge zu klären wie: Welche Programme sind welchen Task zugeordnet, also wo kann ich diese Infos auslesen.
    Aber diese Infos findet man sicher irgent wo, schließlich muss AS die auch haben.

    Prizipiell ist das ganze schon realisierbar, nur realisiert werden müsste es wohl erst noch, weil geben tuts das nach meinem Kenntnissstand nicht. Der Thread war ja für gedacht herauszufinden ob jemand sowas schon mal geschrieben hat oder zumindest weiß wo es sowas gibt. Freut mich aber das dieses Thema nicht nur mich beschäftigt.

  4. #14
    Registriert seit
    12.04.2010
    Beiträge
    300
    Danke
    22
    Erhielt 54 Danke für 52 Beiträge

    Standard

    Zitat Zitat von Sera Beitrag anzeigen
    ... Sprich für Überschriften, Unterüberschriften , einfachen Text, Diagramme... seperate Schlüsselworte, die das dem Dokutool mitteilen wie es die Infos zu Interpretieren hat.
    Das könnte natürlich die Auswirkung haben dass der Code an sich unleserlich wird, wenn zu viele komische Doku-Abschnitte eingepflegt werden.

    Zitat Zitat von Sera Beitrag anzeigen
    Es gibt zwar ( nun ma nur auf B&R bezogen) noch Dinge zu klären wie: Welche Programme sind welchen Task zugeordnet, also wo kann ich diese Infos auslesen.
    Aber diese Infos findet man sicher irgent wo, schließlich muss AS die auch haben.
    Diese Infos sind sehr leicht zugänglich aus div. XML Dateien.

    --
    Ich gebe dir recht, realisierbar wäre es schon, aber als kleines Helpertool kann dass dann nicht mehr beschrieben werden.

    Wäre schön wenn das AS hier einige Features implementieren würde.
    - Callers Graph usw.... wie aus Visual Studio bekannt.
    - Funktion Header Template, ähnlich div. Tabellen z.B. Variablen Liste,
    wo eben nur mehr die Beschreibung zu den Parametern eingegeben werden muss
    - ....

    Ich muss allerdings gestehen dass ich die ganzen Doku-Möglichkeiten des AS auch nicht zu 100% kenne

  5. #15
    Sera ist offline Erfahrener Benutzer
    Themenstarter
    Registriert seit
    08.03.2010
    Ort
    BaWü
    Beiträge
    131
    Danke
    10
    Erhielt 13 Danke für 11 Beiträge

    Standard

    Das könnte natürlich die Auswirkung haben dass der Code an sich unleserlich wird, wenn zu viele komische Doku-Abschnitte eingepflegt werden.
    da würde sich ne möglichkeit finden lassen denk ich

    Diese Infos sind sehr leicht zugänglich aus div. XML Dateien.
    Kann gut sein, hab mich nicht mit beschäftigt

    aber als kleines Helpertool kann dass dann nicht mehr beschrieben
    Muss ja nicht alles auf einmal sein, man könnte ja mit einem Teil mal anfangen

    Vieleicht ließt das ja ein gelangweilter Programierer und schreibt was zu
    Gelangweilt kann ich im Moment nicht nennen

    Wenn jemand damit anfängt, oder was zu schreibt, gerne bei mir melden, vlt find ich ja etwas zeit zwischen rein um mich zu beteiligen.

    Wenn was bei rauskommt kann man das ja event an BR verkaufen

  6. #16
    Registriert seit
    09.11.2007
    Ort
    Rhein Main (Darmstadt)
    Beiträge
    663
    Danke
    61
    Erhielt 112 Danke für 80 Beiträge

    Beitrag

    Wie ich bereits vor einigen Tagen hier gesagt habe, versuche ich mich einmal an so einem Tool.

    Wie immer, wenn man so etwas macht, passt es zu den eigenen Sachen aber sonst eventuell nicht so gut. Ihr könnt mir Beispiel Programme als EXPORT Files senden, damit ich auch daran testen kann. Ich benutze hier CoDeSys 2.x, an Siemens wäre ich natürlich auch interessiert.

    Kommentare und Wünsche willkommen.

    Ich lege mal zum aktuellen Stand einen Screenshot bei.
    Angehängte Grafiken Angehängte Grafiken
    Als Freelancer immer auf der Suche nach interessanten Projekten.
    Zitieren Zitieren Ein erster Prototyp  

  7. #17
    Registriert seit
    23.06.2011
    Beiträge
    19
    Danke
    1
    Erhielt 0 Danke für 0 Beiträge

    Standard

    @RobiHerb: wie sieht es mit Deinem Tool aus? Genau so etwas würde ich derzeit suchen...müsste ein kleines TwinCAT-Projekt in ST dokumentieren....

    Danke

  8. #18
    Registriert seit
    27.04.2010
    Beiträge
    5
    Danke
    3
    Erhielt 0 Danke für 0 Beiträge

    Standard

    Robodoc (http://rfsber.home.xs4all.nl/Robo/) benutze ich für eine einfache Dokumentationsgenerierung mit Beckhoff TwinCat aus dem Quellcode. Das Tool unterstütz jede Sprache , die Kommentare erlaubt.

  9. #19
    Registriert seit
    09.11.2007
    Ort
    Rhein Main (Darmstadt)
    Beiträge
    663
    Danke
    61
    Erhielt 112 Danke für 80 Beiträge

    Standard


    Zuviel Werbung?
    -> Hier kostenlos registrieren
    Zitat Zitat von bbking Beitrag anzeigen
    @RobiHerb: wie sieht es mit Deinem Tool aus? Genau so etwas würde ich derzeit suchen...müsste ein kleines TwinCAT-Projekt in ST dokumentieren....

    Danke
    Wer daran interessiert ist, sollte sich per eMail oder PN melden.
    Als Freelancer immer auf der Suche nach interessanten Projekten.

Ähnliche Themen

  1. Auslesen von Kommentaren
    Von dtsclipper im Forum Simatic
    Antworten: 12
    Letzter Beitrag: 16.02.2009, 11:24
  2. Automatische Reglereinmessung
    Von Majestic_1987 im Forum CODESYS und IEC61131
    Antworten: 14
    Letzter Beitrag: 15.12.2008, 22:46
  3. Automatische Umwandlung von Kop in AWL
    Von Mario_1 im Forum Simatic
    Antworten: 7
    Letzter Beitrag: 13.06.2006, 12:04
  4. Automatische Programmänderung S5
    Von Balou im Forum Simatic
    Antworten: 5
    Letzter Beitrag: 25.04.2004, 18:46

Lesezeichen

Berechtigungen

  • Neue Themen erstellen: Nein
  • Themen beantworten: Nein
  • Anhänge hochladen: Nein
  • Beiträge bearbeiten: Nein
  •