Self-Tcl FORUM - Das deutsche Tcl Tk Forum
www.Self-Tcl.de - Die deutsch-sprachige Tcl/Tk Gemeinschaft im Internet

www.self-tcl.de / TCL Styleguide
Home FORUM Bücher Manual Source
Herzlich Willkommen bei Self-Tcl.de
Die deutsch-sprachige Tcl Gemeinschaft
Infos, Diskussionen, News, Forum & Mehr

www.Self-Tcl.de FORUM
Die deutsche Übersetzung des TCL Styleguide

   TCL Styleguide (deutsch)

6.1. Wesentliche Passagen

Die wichtigsten Teile, die es zu dokumentieren gilt, sind diejenigen, welche die meisten Teile des Programmes beeinflußen. Daher ist es wesentlich, daß jede Prozedurschnittstelle, jede Strukturdeklaration und jede globale Variable klar dokumentiert wird. Wenn Du eines dieser Teile nicht dokumentiert hast, dann ist es notwendig jedes Vorkommen des nicht dokumentierten Teiles zu sichten und herauszufinden, wie es funktioniert; dies ist sehr zeitaufwendig und fehlerträchtig.

Auf der anderen Seite benötigen Quelltextteile mit nur lokalem Bezug keine umfassende Dokumentation. Wenn die generelle Funktion der Prozedur erklärt wurde, und es nicht sehr viel Quelltext in der Prozedur gibt, und wenn die Variablen sprechende Namen haben, dann wird es einfach sein herauszufinden, wie sie verwendet werden. Bei langen Prozeduren hingegen, mit vielen Variablen, sollten zumindest die wichtigsten Variablen beschrieben werden. *

* Diesen Teil hat der Übersetzer bewußt gekürzt, weil darin vom Verfasser einige Punkte aufgeführt sind, die der Übersetzer für nicht sinnvol erachtet. Damit wurde der Diskussion schon ein wenig vorgegriffen. Es geht darum, daß der Verfasser bei kleinen Prozeduren auf die Dokumentation von Variablen völlig verzichten will. Gerade bei kleinen Prozeduren mit wenigen Variablen ist der Aufwand einer Dokumentation so gering, daß hier kein Grund für eine derartige Sparsamkeit bestehen kann. Ansonsten besteht die Gefahr, daß generell auf derartige Dokumentationen verzichtet wird, weil in einem Entwicklerteam Uneinigkeit darüber bestehen kann, ab welcher Größe eine Prozedur als klein angesehen wird, so daß eine saubere Dokumentation entfallen kann.

Dokumentation Keine Quelltextwiedergabe




TCL Styleguide (deutsch)















Domains fuer Babies und Kinder





Neu: Der AMAZON Bücher & Software Shop
Programmierung, Tcl/TK, Software, Bücher, Linux, Unix und Suchen!














Diese Seite als Sartseite einrichten, zu Favoriten / als Lesezeichen hinzufügen und Social Bookmarking:

Bookmark bei: Mr. Wong Bookmark bei: Webnews Bookmark bei: Icio Bookmark bei: Oneview Bookmark bei: Linkarena Bookmark bei: Newskick Bookmark bei: Folkd Bookmark bei: Yigg Bookmark bei: Digg Bookmark bei: Del.icio.us Bookmark bei: Reddit Bookmark bei: Simpy Bookmark bei: StumbleUpon Bookmark bei: Slashdot Bookmark bei: Netscape Bookmark bei: Furl Bookmark bei: Yahoo Bookmark bei: Spurl Bookmark bei: Google Bookmark bei: Blinklist Bookmark bei: Blogmarks Bookmark bei: Diigo Bookmark bei: Technorati Bookmark bei: Newsvine Bookmark bei: Blinkbits Bookmark bei: Ma.Gnolia Bookmark bei: Smarking Bookmark bei: Netvouz Information





| www.Self-Tcl.de | Impressum | Haftungsausschluss |



- TOP -
(zurück nach oben auf dieser Seite)