Improved indices. Added optional parameter for index to *term* macros.

programmingstyle/lecture/programmingstyle-chapter.tex

@@ -5,7 +5,7 @@
 \lstset{inputpath=../code}
 \graphicspath{{figures/}}
 
-\setcounter{page}{55}
+\setcounter{page}{57}
 \setcounter{chapter}{2}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

programmingstyle/lecture/programmingstyle.tex

@@ -136,10 +136,10 @@ die Namensgebung selbst keine weiteren Vorgaben. Allerdings folgt die
 Benennung der in \matlab{} vordefinierten Funktionen gewissen Mustern:
 \begin{itemize}
 \item Namen werden immer klein geschrieben.
-\item Es werden gerne Abk\"urzungen eingesetzt (z.B. \code{xcorr}
-  f\"ur die Kreuzkorrelation oder \code{repmat} f\"ur ``repeat matrix'')
+\item Es werden gerne Abk\"urzungen eingesetzt (z.B. \code{xcorr()}
+  f\"ur die Kreuzkorrelation oder \code{repmat()} f\"ur ``repeat matrix'')
 \item Funktionen, die zwischen Formaten konvertieren sind immer nach
-  dem Muster ``format2format'' (z.B. \code{num2str} f\"ur die
+  dem Muster ``format2format'' (z.B. \code{num2str()} f\"ur die
   Konvertierung ``number to string'', Umwandlung eines numerischen
   Wertes in einen Text) benannt.
 \end{itemize}
@@ -165,9 +165,9 @@ W\"ahrend die Namen von Funktionen und Skripten ihren Zweck
 beschreiben, sollten die Namen von Variablen ihren Inhalt
 beschreiben. Eine Variable, die die mittlere Anzahl von
 Aktionspotentialen speichert, k\"onnte also
-\codeterm{average\_spike\_count} hei{\ss}en. Wenn die Variable nicht
+\varcode{average\_spike\_count} hei{\ss}en. Wenn die Variable nicht
 nur einen sondern mehrere Werte aufnimmt, dann ist der Plural
-angebracht (\codeterm{average\_spike\_counts}).
+angebracht (\varcode{average\_spike\_counts}).
 
 Die Laufvariablen von \code{for}-Schleifen werden oft nur \varcode{i},
 \varcode{j} oder \varcode{k} benannt und sollten aber die einzige Ausnahme
@@ -175,7 +175,7 @@ bzgl. ausdrucksstarker Namensgebung bleiben.
 
 \begin{important}[Benennung von Variablen]
   Die Namen von Variablen sollten m\"oglichst viel \"uber ihren Inhalt
-  aussagen (\code{spike\_count} statt \code{x}). Gute Namen
+  aussagen (\varcode{spike\_count} statt \varcode{x}). Gute Namen
   f\"ur Variablen sind die beste Dokumentation.
 \end{important}
 
@@ -248,7 +248,7 @@ Kommentarzeilen werden in \matlab{} mit dem Prozentzeichen \code{\%}
 gekennzeichnet.  Gezielt und sparsam eingesetzte Kommentare sind f\"ur
 das Verst\"andnis eines Programms sehr n\"utzlich.  Am wichtigsten
 sind kurze Kommentare, die den Zweck und das Ziel eines Abschnitts im
-Programm erl\"autern (z.B. \code{\% compute mean firing rate over all
+Programm erl\"autern (z.B. \varcode{\% compute mean firing rate over all
   trials}).
 
 Viele und h\"aufige Kommentare k\"onnen in der Entwicklungsphase eines
@@ -259,7 +259,7 @@ Zeilen sowieso weitestgehend selbsterkl\"arend sein.
 Die beste Dokumentation ist der Code selbst. Gut geschriebener Code
 mit ausdrucksstarken Variablen- und Funktionsnamen ben\"otigt keine
 Kommentare, um den Zweck einzelner Zeilen zu erkl\"aren. z.B. ist\\
-\code{ x = x + 2;   \% add two to x}\\
+\varcode{ x = x + 2;   \% add two to x}\\
 ein v\"ollig unn\"otiger Kommentar.
 
 \begin{important}[Verwendung von Kommentaren]
@@ -333,10 +333,10 @@ lokale Funktion.
 Lokale Funktionen existieren in der gleichen Datei und sind nur dort
 verf\"ugbar. Jede Funktion hat ihren eigenen G\"ultigkeitsbereich, das
 hei{\ss}t, dass Variablen aus den aufrufenden Funktionen nicht
-sichtbar sind. Bei sogenannten \codeterm{geschachtelten Funktionen}
+sichtbar sind. Bei sogenannten \codeterm[geschachtelte Funktionen]{geschachtelten Funktionen}
 ist das anders. Diese werden innerhalb eines Funktionsk\"orpers
-(zwischen den Schl\"usselworten \codeterm{function} und dem
-\codeterm{end} definiert und k\"onnen auf alle Variablen der
+(zwischen den Schl\"usselworten \code{function} und dem
+\code{end} definiert und k\"onnen auf alle Variablen der
 ``Mutterfunktion'' zugreifen und diese auch ver\"andern. Folglich
 sollten sie nur mit Bedacht eingesetzt werden.