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

Seite 1 von 2 12 LetzteLetzte
Ergebnis 1 bis 10 von 13

Thema: Softwaredokumentation

  1. #1
    Registriert seit
    11.01.2010
    Beiträge
    65
    Danke
    28
    Erhielt 2 Danke für 2 Beiträge

    Standard


    Zuviel Werbung?
    -> Hier kostenlos registrieren
    Hallo,

    das alte leidige Thema der Softwaredokumentation. Mich würde einmal interessieren wie Ihr im S7 Variablen, Netzwerke, Header, FB's; und FC's kommentiert.


    Gruß Marius
    Zitieren Zitieren Softwaredokumentation  

  2. #2
    Registriert seit
    03.01.2010
    Ort
    Augsburg
    Beiträge
    59
    Danke
    4
    Erhielt 11 Danke für 11 Beiträge

    Standard

    Hallo Marius,
    als bei mir ist JEDER der nicht kommentiert ein persönlicher Feid - zum Abschuss freigegeben. Ich hasse es, wenn ich immer wieder vor Problem : "was wollte der Künstler uns damit sagen ?" stehe. Also wenn um mich geht wird im Prinzip ALLES kommentiert, daß heist:
    1. Jedes Netzwerk als Überschrifft - Funktion: was wird dort gemacht und manchmal: wozu
    2. Im AWL : jede Programmzeile
    3. Im jedem FC/FB genaue Beschreibung von : Zweck, Ersteller, Version-Nr., was macht der Baustein und auf welche weise.
    Und so weiter, u.s.w...
    Ich muß dir sagen, ich liebe es wenn Kunden genaue vorgaben hier machen und danach KONTROLLIEREN !! Ein Kollege von mir hatte ganze 4 Wochen in China auf eigene Kosten gesessen und sein Programm kommentiert, weil der Endkunde es abgelehnt hatte, die Abnahme zu unterschreiben.
    Mir ist schon passiert, daß ich dem Kunden das ganze (oder Teile vom) Programm neu geschrieben habe, weil das Alte nicht zu gebrauchen war, da keine Kommentare.
    Janusz

  3. Folgender Benutzer sagt Danke zu janusz für den nützlichen Beitrag:

    Matthias_VER (12.02.2010)

  4. #3
    Registriert seit
    17.04.2007
    Ort
    Kiel
    Beiträge
    496
    Danke
    162
    Erhielt 67 Danke für 63 Beiträge

    Standard

    Also tendenziell sehe ich es genau wie janusz. Ich bin jetzt jetzt fast 20 Jahre dabei. Ich kann mich nicht erinnern, ein so gut dokumentiertes Programm gesehen zu haben, wie es janusz beschreibt. Aber ich habe schon ganz viele Programme gesehen, in denen nichts kommentiert war. Letztes Jahr hatte ich ein recht großes Programm in FUP mit sehr vielen Merkern (warum auch immer). Keiner hatte ein Symbol oder Kommentar. Es gab zwar NW-Überschriften, aber der Sinn blieb trotzdem dunkel.

    - erstmal muss ein Programm vernünftig strukturiert sein
    mit Antriebsbausteinen
    mit Funktionsgruppen usw
    - der Symbolische Name sollte kopierfreundlich sein
    alle Symbole von Pumpe 1 und Pumpe 2 sind identisch und unterscheiden
    sich nur in PU1xxxx und PU2xxxxx
    Das Gleiche gilt für Maschine A und B mit jeweils 20 Pumpen
    Jedes Netzwerk erhält eine Überschrift und häufig machen auch ein paar Zeilen Kommentar Sinn.

    Wenn man selbst Pflichtenheft/Funktionsbeschreibung etc. macht, macht es auch Sinn die Beschreibung analog zu den Bausteinen aufzubauen.
    So einfach wie möglich – so kompliziert wie nötig.

  5. #4
    Registriert seit
    07.06.2006
    Ort
    Bayern
    Beiträge
    623
    Danke
    27
    Erhielt 156 Danke für 139 Beiträge

    Standard

    Servus,

    also ich kommentiere ja auch fleissig und reichlich. Ich hasse es auch, wenn ich vor einem fremden Programm sitze, indem keine Kommentare ja geschweige denn Symbolnamen vergeben sind

    aber wie von janusz beschrieben

    Zitat Zitat von janusz Beitrag anzeigen
    2. Im AWL : jede Programmzeile
    jede Programmzeile zu dokumentieren, das finde ich etwas übertrieben.

    Bsp.: Addition von 5 REAL-Werten

    Code:
    //Berechnung von BlaBlaBa
    
    L #Wert1
    L #Wert2
    +R
    L #Wert3
    +R
    L #Wert4
    +R
    L #Wert5
    +R
    T #Ergebniss
    
    //Naechster Block
    ...
    hier sollte es ja ausreichen, wenn der Sinn der Addition kommentiert ist.

    Mfg
    uncle_tom

  6. #5
    Registriert seit
    03.01.2010
    Ort
    Augsburg
    Beiträge
    59
    Danke
    4
    Erhielt 11 Danke für 11 Beiträge

    Standard

    Hallo ihr beiden
    selbstverständlich habt ihr beide Recht .-) soooo fleissig bin ich auch nicht. Einfache Operationen die sogar für "dummies" sofort erkennbar sind, werden nicht (oder selten) von mir kommentiert. Grundsätzlich gehe ich aber von der Annahme aus, daß ich nicht beweisen muß was ich für ein toller Programmierer bin und am Ende nur ein Betriebselektriker (oft im Ausland auch ohne besondere Ausbildung) sich ev. damit beschätigen wird.
    Nichtdestoweniger betrachte ich ein Programm ohne Kommentare als Schrott und ein Zeichen von Faulheit und Arroganz des Programmierers.
    Grüße
    Janusz

  7. #6
    Registriert seit
    11.01.2010
    Beiträge
    65
    Danke
    28
    Erhielt 2 Danke für 2 Beiträge

    Standard

    Guten Morgen,

    erstmal danke für eure Meinungen. Hoffe das da noch ein paar mehr kommen. Bekommt man das mit dem Kommentieren nicht auch schon in der Ausbildung beigebracht?

    @ janusz

    "Einfache Operationen die sogar für "dummies" sofort erkennbar sind.......", auch diese Funktionen sollten zumindest mit einer "Überschrift" beschrieben werden. Damit auch die Jungs aus der Doku damit zurecht kommen.

  8. #7
    Registriert seit
    03.01.2010
    Ort
    Augsburg
    Beiträge
    59
    Danke
    4
    Erhielt 11 Danke für 11 Beiträge

    Standard

    @MariusW

    ist doch Klar, mein Post war bezogen auf die Antwort von Uncle - in so einem Fall wie seins mache ich keine Zeilenkommentare - das war damit gemeint. Sonst gibt es eine Regel: kein Netzwerk ohne Kommentar - im schlimmsten Fall "copy&paste"
    Und mit den "dummies" war nicht abwertend gemeint (diesen Begriff sollte mein mit "Beginners" assozieren), ich weiss sehr gut, daß kein Meister vom Himmel gefallen ist und jeder auch irgendwann lernen Muß.
    Ob man das in der Ausbildung mitbekommt? Keine Ahnung, manchmal habe ich meine zweifel. Ich habe das sozusagen im Blut da ich als älterer semester vom Assembler programmierung komme - dort kriegt man das Kommentieren mit Schweiss und Tränen eingebrannt
    Grüße
    Janusz

  9. #8
    Registriert seit
    11.01.2010
    Beiträge
    65
    Danke
    28
    Erhielt 2 Danke für 2 Beiträge

    Standard

    @janusz
    das war mir schon bewust!

  10. #9
    Registriert seit
    13.03.2006
    Beiträge
    428
    Danke
    5
    Erhielt 43 Danke für 43 Beiträge

    Standard

    Ich finde, diese Diskussion zeigt mal wieder, dass es besser wäre SPS'en in einer Hochsprache zu programmieren.

    Das hier erinnert mich mehr oder weniger an die Art und Weise, wie man Assembler programmiert.
    In einer Hochsprache kann man Variablen und Funktionen sinnvolle Namen geben und man kann objektorientiert programmieren.

    Kommentare haben den Nachteil, dass sie von Compiler ignoriert werden.
    In schlimmsten Falls können Kommentare irrelevant oder gar falsch sein.

    Wenn ich jetzt in einer Hochsprache wie C/C++ programmieren
    kann, habe ich eine Vielzahl ausgereifter Werkzeuge zur Verfügung.
    Z.B. kann man mit
    http://www.stack.nl/~dimitri/doxygen/
    Programmcode hervorragend gut dokumentieren.
    Die "Prosa" wird dabei in speziell formatierten Kommentaren im Quelltext selbst untergebracht.

    Diese Vorgehensweise verwende ich jedenfalls, wenn ein PC (auch embedded) + Remote I/O eingesetzt wird.

    Wenn sich nun ein Anbieter (China|Korea ???) finden würde,
    der eine SPS auf den Markt bringt, die mit C/C++ programmiert werden kann, bin ich sofort dabei.

    Eine SPS ist ja nix weiter als ein kleiner Computer + I/O in einem industrietauglichen Gehäuse für den Schaltschrank.

  11. Folgender Benutzer sagt Danke zu pvbrowser für den nützlichen Beitrag:

    Matthias_VER (12.02.2010)

  12. #10
    Registriert seit
    18.09.2004
    Ort
    Münsterland/NRW
    Beiträge
    4.718
    Danke
    729
    Erhielt 1.158 Danke für 969 Beiträge

    Standard


    Zuviel Werbung?
    -> Hier kostenlos registrieren
    Zitat Zitat von pvbrowser Beitrag anzeigen
    ...
    Das hier erinnert mich mehr oder weniger an die Art und Weise, wie man Assembler programmiert.
    In einer Hochsprache kann man Variablen und Funktionen sinnvolle Namen geben und man kann objektorientiert programmieren.
    ...
    Also kann ich in TwinCAT oder RSLogix oder so den Variablen und Funktionen keine sinnvollen Namen geben?
    TwinCAT hat jetzt auch objektorientierte Erweiterungen

    Zitat Zitat von pvbrowser Beitrag anzeigen
    ...
    Kommentare haben den Nachteil, dass sie von Compiler ignoriert werden.
    In schlimmsten Falls können Kommentare irrelevant oder gar falsch sein.
    ...
    Hatte ich vergessen. In einer Hochsprache können Kommentare nicht
    "irrelevant oder gar falsch sein."

    Zitat Zitat von pvbrowser Beitrag anzeigen
    ...
    Wenn ich jetzt in einer Hochsprache wie C/C++ programmieren
    kann, habe ich eine Vielzahl ausgereifter Werkzeuge zur Verfügung.
    Z.B. kann man mit
    http://www.stack.nl/~dimitri/doxygen/
    Programmcode hervorragend gut dokumentieren.
    Die "Prosa" wird dabei in speziell formatierten Kommentaren im Quelltext selbst untergebracht.
    ...
    Es steht jedem frei, doxygen so zu erweitern um auch den Programmcode
    von SPS-Programmen zu dokumentieren

    Zitat Zitat von pvbrowser Beitrag anzeigen
    ...
    Wenn sich nun ein Anbieter (China|Korea ???) finden würde,
    der eine SPS auf den Markt bringt, die mit C/C++ programmiert werden kann, bin ich sofort dabei.
    ...
    TwinCAT kannst du in einer Hochsprache programmieren. Die kommen nur
    leider nicht aus "China|Korea"

Ähnliche Themen

  1. Softwaredokumentation inkl. Bugliste als Datenbanklösung
    Von Anonymous im Forum Programmierstrategien
    Antworten: 3
    Letzter Beitrag: 06.02.2006, 13:09

Lesezeichen

Berechtigungen

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