---
description: '@Glimpse ( coming soon )'
---

# Clean Template

The way to define code quality is often defined in a so called "Style-Guide"

A Lot of this are avaible and all well thought.

The one we can use in the course is the numpy style guide:

[https://numpydoc.readthedocs.io/en/latest/format.html](https://numpydoc.readthedocs.io/en/latest/format.html)

More Informations you find under : [https://github.com/ohioh/CleanCode](https://github.com/ohioh/CleanCode)

```
#########################################################################################################################################################
#
# * TAKE CARE ABOUT YOUR CLEAN CODE - Kapitel
# *  Nutzen und Einsatz von verschiedenen Kommentaren
# *  Purpose: beeing able to create well understandable code
# *  
# *  @file kommentare.py
# *  @author Tjark Ziehm
# *  @version 0.9 15.Oktober 2015 
# *
# * Developed for the LSST Data Management System.
# * This product includes software developed by the LSST Project
# * (https://www.lsst.org).
# * See the COPYRIGHT file at the top-level directory of this distribution
# * for details of code ownership.
# *
# * This program is free software: you can redistribute it and/or modify
# * it under the terms of the GNU General Public License as published by
# * the Free Software Foundation, either version 3 of the License, or
# * (at your option) any later version.
# *
# * This program is distributed in the hope that it will be useful,
# * but WITHOUT ANY WARRANTY; without even the implied warranty of
# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# * GNU General Public License for more details.
# *
# * You should have received a copy of the GNU General Public License
# * along with this program.  If not, see <https://www.gnu.org/licenses/>.
# */
#########################################################################################################################################################

# Test-Wert für print-Test
zahl = 1;


#############################################Segment#############################################################################################

#**************************************************************************/
#    Funktionsbenennung
#    @brief  seperation logical blocks
#    @param  line of single deviding commenting symbol like /,# or /* and */    
#
#**************************************************************************/


"""
|| Lokaler Kommentar und Notizbereich
|| This event is defined but not used in the code. No
|| point in wasting codespace on it.
||
"""
```
