Code Kommentare angefangen

rieter_ekalk.py

@@ -7,7 +7,15 @@ JSON_IDENT = 5
 
 
 class cfg():
+    """
+    Liest die config-Datei ein, in der Stückpreise und Zeiteinheiten pro Bauteil wie in der rieter_ekalk Excel-Datei verwendet angegeben sind, und schreibt sie in ein Dictionary.
+    """
     def __init__(self, path="Daten_cfg.txt"):
+        """
+        :param path: Die config-Datei, in der Stückpreise und Zeiteinheiten der jeweiligen Bauteile aufgelistet sind z.B.[HW_Einzelpreise]
+                                                                                                                        # Schaltschrank Einzelpreis
+                                                                                                                        schaltschrankgehaeuse_b1x800_zubehoer = 2000
+        """
         self._hasConfig = True
         if os.path.exists(path):
             self._cfg = configparser.ConfigParser(inline_comment_prefixes="#")
@@ -20,6 +28,10 @@ class cfg():
         return self._hasConfig
 
     def getDictAsFloat(self, section):
+        """
+        Schreibt die Zuordnungen von Bauteil:Stückpreis/Zeiteinheit (je nach gewählter Überschrift) aus der config-Datei in ein Dictionary.
+        :param section: Überschrift in der config-Datei z.B. "HW_Einzelpreise"
+        """
         res = dict()
         for key, val in self._cfg.items(section):
             res[key] = float(val)
@@ -171,9 +183,17 @@ class MG():
 
 
     def get_deckblatt_value(self, key):
+        """
+        Gibt eingegebenen Wert des Eingabeparameters zurück.
+        :param key: Name eines Eingabeparameters im Deckblatt z.B. "Begegnungsstrecke_Bypass"
+        """
         return self._deckblatt.get(key, 0)
 
     def get_value_of_object(self, objectname, key):
+        """
+        :param objectname: Name der Klasse, zu der das Bauteil gehört, dessen Wert man wissen will z.B. "puffer"
+        :param key: Name des Bauteils, dessen Wert ermittelt werden soll z.B. "Sensor_optisch_Traverse"
+        """
         # Deckblatt
         if (objectname.lower() == "deckblatt"):
             return self._deckblatt.get(key)