Skip to content

Entwicklungs Richtlinien

bmxp edited this page Jun 20, 2016 · 5 revisions

Richtlinien (mind. für den SmartHomeNG Core):

- Die Entwicklung sollte sich an [PEP 8 -- Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/) anlehnen. - Funktions-, Attributs- / Klassenbezeichnungen (etc.) und Kommentare bitte in Englisch - Codekommentare so, dass sie mit Sphinx generiert werden können (http://thomas-cokelaer.info/tutorials/sphinx/docstring_python.html). Beispiel (Methodenkommentar):
    """
    Builds the soap data set (from body and envelope templates) for a given request.

    :param action: string of the action
    :param service: string of the service
    :param argument: dictionary (name : value) of arguments
    :return: string of the soap data
    """

Für die Plugin-Entwicklung werden die o.g. Guidelines empfohlen.

Weitere Tipps:

- [Python Performance Tipps](https://wiki.python.org/moin/PythonSpeed/PerformanceTips)