Select Git revision
program_comment.html
Anian Bühler authored
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
program_comment.html 6.62 KiB
<!DOCTYPE html>
<html>
<link rel="stylesheet" href="_seitenformatierung.css">
<body style="margin: 0px;">
<div style="border: #284a66; border-style: solid; border-width: 5px;">
<nav>
<li id="beschreibung">Block-Referenz</li>
<div style="border: 2px, solid; margin-left: 14px;"><li> <a target="_blank, _tab" href="https://letsgoing.org/"><img id="letsgoing_logo" src="_Logo_LGI_page.png"></a> </li></div>
<li style="float: right;" ><a id="uebersichtbutton" href="https://blockreferenz.letsgoing.org" target="_blank, _tab">Übersicht aller Blöcke</a></li>
</nav>
</div>
<div>
<section>
<div id="ueberschrift">
<p>Kommentare/Code</p>
<h1 style="font-size: 220%;">Programmkopf</h1>
</div>
<div>
<div>
<figure>
<img id="block_bild" src = "program_comment.png" usemap="#blockmap" alt="größer-gleich-block"></img>
<figcaption id="caption">Für Erklärung auf einzelne Komponenten klicken.</figcaption>
</figure>
</div>
<map name="blockmap">
<area shape="rect" coords="20, 20, 157, 260" href="#block_beschreibung" title="Block"></area>
<area shape="rect" coords="186, 20, 612, 60" href="#dateiname" title="Dateiname des Programms"></area>
<area shape="rect" coords="212, 60, 500, 90" href="#autor" title="Autor(en) des Programms"></area>
<area shape="rect" coords="162, 98, 650, 130" href="#beschreibung" title="Kurze Beschreibung der Funktion des Programms"></area>
<area shape="rect" coords="215, 192, 418, 224" href="#datum" title="Datum der letzten Versionsänderung"></area>
<area shape="rect" coords="198, 231, 350, 260" href="#version" title="Aktuelle Version des Programms"></area>
</map>
</div>
</section>
</div>
<article>
<div>
<h2 class="unterueberschrift" id="block_beschreibung">Block</h2>
<p>
Der <code>Programmkopf</code> Block hat keine Auswirkungen auf den Ablauf des Programmes. Seine Funktion ist es lediglich eine
Information über das Programm zu geben.
Wenn man mehrere Programme hat oder diese längere Zeit nicht genutzt hat, dann kann man schnell den Überblick verlieren
welche Funktionalitäten wo eingefügt wurden
und muss sich diese Informationen falls möglich aus dem Code selbst herauslesen, was nicht immer einfach und schnell ist.
Die Kommentarfunktion ist daher eine sehr nützliche Anwendung und wird in der Softwareentwicklung überall eingesetzt.
<br><br>
Der Kommentar, der mit diesem Block geschrieben wird, kann allerdings nicht mitten im Text eingefügt werden.
Im generierten Code werden diese Informationen bereits <b>vor</b> den ersten Befehlen eingefügt.
</p>
<h2 class="unterueberschrift" id="">Dateiname</h2>
<p>
Hier wird der Name der Datei eingetragen.
Dieser sollte bereits den Code sehr knapp beschreiben.
<br>
Das heißt nicht einfach nur "Datei_1, Datei_2, Datei_3...", sondern zum Beispiel "LED_blink" oder "roboter_steuerung".
<p>
<h2 class="unterueberschrift" id="">Autor</h2>
<p>
Hier wird der Name von einer oder mehreren Personen eingetragen, die am Programm mitgearbeitet werden.
Besonders bei größeren Projekten, an denen mehrere Entwicklerinnen oder Entwickler mitwirken, ist dies notwendig.
<p>
<h2 class="unterueberschrift" id="">Beschreibung</h2>
<p>
Hier wird die Funktion des Programms in 2 bis 3 kurzen Sätzen zusammengefasst.
Nützlich ist es auch in einem Satz die Änderungen zu beschreiben, die zur letzten Version gemacht wurden.
<p>
<h2 class="unterueberschrift" id="">Datum</h2> <p>
Hier kann das Datum des letzten Bearbeitungstages eingetragen werden.
<p>
<h2 class="unterueberschrift" id="">Version</h2>
<p>
Hier wird die aktuelle Programmversion eingetragen, falls mehrere Versionen erstellt und gespeichert wurden.
<p>
<h2 class="unterueberschrift" id="">Code</h2>
<p>
Obwohl der <code>Programmkopf</code> Block keine direkte logische Funktion im Code besitzt, kommt er darin
jedoch sehr wohl vor.
<br><br>
Kommentare in der Arduino IDE, die in einer Zeile eingefügt werden sollen beginnen mit zwei "Slashs" (<code>//</code>).
Die ganze Zeile, die rechts von diesen Symbolen steht wird in grauer Farbe dargestellt und beim Programmablauf ignoriert.
Sie dient nur als Hinweis für den Programmierer oder die Programmiererin.
Als Kommentar kann alles Denkbare in Textform eingetragen werden.
<br><br>
<b>Beispiel:</b> In einer Zeile soll der Kommentar "Hier wird die Variable xy um 1 hochgezählt" eingefügt werden.
Das würde im Code so aussehen:
<br><br>
<code>
//Hier wird die Variable xy um 1 hochgezählt
</code>
<br><br>
Es sind auch ganze Kommentarblöcke möglich.
Als ein solcher Block wird auch der <code>Programmkopf</code> Block realisiert.
Hier wird der Kommentar mit einem Slash und einem Sternchen eingeleitet (<code>/*</code>) und mit einem Stern und einem Slash abgeschlossen (<code>*/</code>).
Alles was dazwischen steht wird im Programmablauf ignoriert.
Auch hier kann auch wieder alles mögliche in Textform geschrieben werden.
<br><br>
Hier ein <b>Beispiel</b> dazu wie ein ausgefüllter <code>Programmkopf</code> Block im Code ausgeführt wird:
<br>
Block:
<br><br>
<img src="program_comment-beispiel.png" alt="">
<br><br>
Code:
<br><br>
<code>
/** <br>
 * file: blink_programm <br>
 * author: Max Mustermann <br>
 * <br>
 * description: <br>
 * Dieses Programm bringt eine LED am digitalen Pin 1 zum blinken <br>
 * Sie ist immer eine Sekunde an und 0,5 Sekunden aus <br>
 * <br>
 * date: 01.01.2021 <br>
 * version: 1.0 <br>
*/ <br>
</code>
<p>
</div>
</article>
</body>
</html>