Hallo,
suche sinnvolle Varinten für die Kommentare am Anfang/ (und innerhalb) einer Datei wie zB.
Autor, Version, Aufgabe, Datum, To-Do, Bugs, Tested,...
Auch Gestaltungsmöglichkeiten (zB. Funtionen abteilen) innerhalb des Codes würden mich interessieren.
Habe das bisher nach eigenem Empfinden gemacht und im Netz noch nicht so viel gefunden, da mir auch nicht klar ist, wie die Begriffe dafür lauten.
Script Header/ Code Desing?
Vielen Dank für Links oder die richtigen Suchbegriffe.
Du möchtest also wissen wie viel und wie man sinnvoll kommentiert?
Grüße Uwe
Ja auch, mehr fast noch, wie man es mit asci zeichen übersichtlich und informativ gestaltet ohne dass es zu lang oder schlecht zu warten/ergänzen ist.
Ich vermute es gibt da schon sehr schöne vorlagen/Beispiele, nur wonach muss ich suchen?
ToDos etc sind normalerweise in einem Quellcode eher unüblich.
Ob nun
// Author : xy
// Date : ....
steht, ist vollkommen egal. Hauptsache, es sind alle wichtigen Informationen enthalten
ich habe für meine Funktionen immer einen Funktionskopf:
/*************************************************************************************************
** Funktionsname **
**************************************************************************************************
** Funktionsbeschreibung **
** **
** **
** **
** **
** Input: **
** Output: **
** genutzte Globale Variablen: **
**************************************************************************************************/
Ansonsten habe ich auf dem ersten Tab, einen Block mir kurzer Projektbeschreibung, Autor, Datum, Hardware etc. und, ganz wichtig, eine Änderungshistorie!
Und, ja, auch ich mache mir im Code schon mal ToDo-Anmerkungen.
So ähnlich habe ich es bisher gemacht (die einzelnen To-Do's/Done's/Bug's haben eigentlich noch ne Nummer, die dann in der Liste eingetragen werden):
[code]/********************************************************************
File: VORLAGE.ino
Info: einfache Vorlage
Autor: JB
Date; Vers; kB; Ram; inProg.; Finish; Bugs; To-Do;
-------------------------------------------------------------------
150627 100
To-Do/Finished-List (Prio)
-------------------------------------------------------------------
Done/working:
Serial, FCN/Task, LED13, D I/O, DEBUG, LCD, Backlight_auto_off_rest,
Serial Parse(RS232-Befehl, Debug-Level),
To-Do:
Button (debounce), Drehencoder(++,--), ADC (Oversmpl, Average, EEPROM Save),
PCI(Mega), RTC, SD, WEB, LowPowerSleep/StayIdel(Mega),
Bugs:
delte entire rs232 buffer on rx startMarker,
Bug-List => Solution /work arround
-------------------------------------------------------------------
A.
B.
*********************************************************************/
//### includes ################################################################
#include "myHelpers.h" // my defines
#include <Wire.h> // I2C
#include <LiquidCrystal_I2C.h> // I2C LCD 20x4 Display
//### global Variables for Functions ##########################################
const u_long maxSleep = 60000; // max sleepd ms at once [ms]
u_long jetzt = 0; // now in ms (millis+sleeped)
u_long next_global = maxSleep; // global next for max sleep
u_long sleeped_global = 0; // Sleeped ms
//### global Variables for Debugging ##########################################
bool debug_0 = 0; // enable Debug_0 FCN exe. Info
bool debug_1 = 0; // enable Debug_1 Sleep Info
//### Serial Parse global Variables ##########################################
[/code]
Ich notiere mit eine To-Do/Bug/etc. Liste im Scriptkopf da ich sonst nach einigen Tagen nicht mehr weiß was der Stand war. Ich hatte ja auch schon in einem andren Thread nach einem Tool zur Verwaltung von Code/Projekten gefragt, aber noch nicht das passende für mich gefunden.
Nachteil: der Kopf (vor allem die To-Do/ Done-Listen) werden mit der Zeit zu groß und das eintragen in die Liste ist wegen der (fehlenden) Formatierung nicht sehr vorteilhaft.
Auch fehlt ein Automatisches ändern des LastEdit- Date durch den Compiler, oder geht das?
Wonach muss ich suchen um mehr Beispiele wie das von guntherb zu finden?
Vielen Dank!
Auch fehlt ein Automatisches ändern des LastEdit- Date durch den Compiler, oder geht das?
Versionsverwaltungssysteme tragen sowas ein.
Es gibt die verschiedensten Documentationssysteme, Autodoc ist zB. so eins
http://www.openoffice.org/tools/autodoc/HowToWriteDocumentation-Cpp.html