Visual Basic .NET/ Projekt

Das ist der Sammelpunkt für alle Informationen zum Buchprojekt Visual Basic .NET.

Mitarbeiter

Wir möchten alle bitten, die an diesem Wikibook konstruktiv mitarbeiten möchten, sich hier einzutragen:

Zielgruppe

Dieses Buch richtet sich ausdrücklich an Anfänger, die noch nie zuvor programmiert haben. Deshalb bitte ich Euch, Codebeispiele, bestimmte Verhaltensweisen oder Syntaxelemente genau zu erklären. Jeder Fachbegriff muss im Buch nur einmal definiert werden, danach kann er beliebig oft verwendet werden. Oftmals scheitert ein Buch für Anfänger daran, dass bestimmte Themen nicht genau genug erklärt werden, weil ein Autor denkt, dass sich zum Beispiel Themen wie Variablen oder Operatoren total logisch sind und keiner weiteren Erklärung bedürfen. Trotzdem braucht Ihr Euch über den Detailgrad Eurer Aussagen erstmal keine Sorgen zu machen. Schließlich werfe ich fast jeden Tag einen prüfenden Blick auf das Buch und habe alle Kapitel auf meiner Beobachtungsliste.

Projektstatus

Die Entstehung des Buches lässt sich in drei Phasen einteilen.

Schreibphase (läuft) - Zuerst muss das Buch geschrieben werden. Dabei wird nach und nach auch die endgültige Struktur festgelegt. Hoffentlich schaffen wir das bis Ende 2006.
Reviewphase - Hier wird der gesamte Inhalt fachlich und sprachlich geprüft und, falls notwendig, überarbeitet. Außerdem werden die definierten Formatierungsregeln (s.u.) angewendet, falls noch nicht geschehen. Wenn alles gut geht, dauert das 2 bis 3 Monate. Erst wenn ein Kapitel gereviewt wurde, wird der Status im Inhaltsverzeichnis auf 10 gesetzt.
Erweiterungsphase - Nach Fertigstellung der unbedingt zum Erlernen der Sprache benötigten Kapitel sollten noch einige komplexe Beispiele ergänzt werden, zum Beispiel Datenstrukturen wie verkettete Listen oder binäre Bäume, oder auch praxisbezogene Beispiele wie ein kleiner Texteditor. Wahrscheinlich sind auch Erklärungen zum Debugging mit den Entwicklungsumgebungen sehr nützlich.

Informationen zum Vorlagensystem

Die Hauptseite Visual Basic .NET ist als Vorlage mit den Parametern res und all konzipiert. So können die Einstellmöglichkeiten des neuen dynamischen Inhaltsverzeichnisses ausgenutzt werden. Die normale Hauptseite zeigt im Inhaltsverzeichnis nun nur noch existente Kapitel, außerdem keine Autorenressourcen. Mit der Ansichtswahl rechts neben dem Inhaltsverzeichnis kann man den Umfang und den Detailgrad des Inhaltsverzeichnisses ändern. Die Vorlage:Inhaltsverzeichnis ist eine Liste von Inhaltsverzeichniseinträgen, die durch die Vorlage:Inhaltsverzeichniseintrag realisiert werden. Die verschiedenen Ansichten der Hauptseite findet man unter Visual Basic .NET, Visual Basic .NET/ all, Visual Basic .NET/ res und Visual Basic .NET/ allres.

Alle anderen Vorlagen sind hauptsächlich Textbausteine. Alle basieren direkt oder indirekt auf der bucheigenen Boxvorlage. Häufige Textbausteine zur Bezogenheit auf bestimmte Entwicklungsumgebung bezogenen Inhalten sind vorformuliert.

Statusanzeigen

Wie fast jedes andere Inhaltsverzeichnis verwendet auch unser dynamisches Inhaltsverzeichnis die Vorlage:Status. Diese wird von der Inhaltsverzeichniseintragsvorlage eingebunden. Um den Status eines Kapitels zu ändern, bearbeitet die Vorlage:Inhaltsverzeichnis. Sucht am besten mit der Suchfunktion Eures Browsers nach dem entsprechenden Kapitelnamen oder der Kapitelnummer. Ihr solltet so einen Eintrag finden:

}}{{:Visual Basic .NET: Vorlage:Inhaltsverzeichniseintrag
|link=Visual Basic .NET: Programmiertechniken
|name=1. Programmiertechniken
|indent=**
|status=9
|mustexist=1

Setzt den Wert für status auf den gewünschten Statuswert. Mögliche Werte sind:

in der Schreibphase
- 0 - Das Kapitel existiert noch nicht oder ist nur ein Baugerüst aus Überschriften.
- 1 bis 8 - Ein Teil des Kapitels ist schon ausformuliert, aber noch nicht alles. Die Höhe der Zahl entspricht dem Grad an fertigem Text.
- 9 - Das Kapitel ist vollständig ausformuliert und kann so höchstwahrscheinlich schon als konsistente Wissensquelle benutzt werden.
in der Reviewphase
- 9 - Das Kapitel wurde noch nicht oder noch nicht vollständig reviewt.
- 10 - Das Kapitel ist absolut fertig. Ab diesem Zeitpunkt werden inhaltliche Änderungen nur noch nach vorheriger, mindestens einwöchiger Absprache auf der jeweiligen Diskussionsseite mit anderen Autoren vorgenommen und nur, wenn auf der Disku eine bestimmte Formulierung mehrheitlich akzeptiert wurde. Diese Frist gilt natürlich nicht für orthografische oder inhaltliche Fehler.

In der Zusammenfassung deines Edits gibst Du zum Beispiel "4.5. auf 6" an, wenn Du den Status des Kapitels 4.5. auf 6 gesetzt hast.

Formatierungsregeln

Zum Erfolgsrezept guter Bücher gehört immer auch ein ansprechendes Äußeres. Deshalb gibt es ein paar Formatierungsregeln. Es ist aber nicht so schlimm, wenn Ihr sie vor lauter Schreibeifer vergesst. Dafür gibt es schließlich die Reviewphase.

Verwendet bitte die neue Rechtschreibung. Die Anrede der Wahl ist „Sie“, ich bitte darum, das „Sie“ (und auch „Ihr“, „Ihnen“ etc.) immer groß zu schreiben, damit man es von „sie“ im Sinne von z.B. „die Befehle“ unterscheiden kann.
Neue Begriffe sollten immer fett gesetzt werden, um den Text optisch zu strukturieren. Außerdem wird so das schnelle Auffinden einer Definition oder Erklärung erleichtert.
Schlüsselwörter wie Private oder True sowie selbstvergebene Namen wie Funktions- und Variablennamen sollten kursiv gesetzt werden, um die besondere Bedeutung dieser Begriffe kenntlich zu machen.
Tabellen sollten mit der Vorlage:Prettytable formatiert werden, d.h. statt der einleitenden Zeile {| steht {| {{Prettytable}}.

Codebeispiele

Vollständige Codebeispiele werden mit der regaleigenen Code-Vorlage formatiert. So wird die Vorlage eingebunden:

{{:Regal:Programmierung: Vorlage:Code
|code= 
 Dim a As String = InputBox("Sag mal ""Hallo"".")
 If a = "Hallo" Then
     MessageBox.Show("Gut.")
 Else
     MessageBox.Show("Falsch.")
 End If
|output= 
 Gut. (Falls "Hallo" eingegeben wurde.)
 Falsch. (Andernfalls.)
}}

wird zu

Code:

Dim a As String = InputBox("Sag mal ""Hallo"".")
If a = "Hallo" Then
    MessageBox.Show("Gut.")
Else
    MessageBox.Show("Falsch.")
End If

Output:

Gut. (Falls "Hallo" eingegeben wurde.)
Falsch. (Andernfalls.)

Dabei ist kopf der Text, der obenan steht, und fuss der Text, der unter dem Codebeispiel steht. code ist der eigentliche Quelltext. Das   lasst Ihr stehen, der Code beginnt erst in der nächsten Zeile. Beachtet außerdem, dass am Anfang jeder Codezeile ein zusätzliches Leerzeichen eingefügt werden muss. output ist schließlich die Ausgabe, die dieser Code erzeugt. Wenn eine Ausgabe nur unter einer bestimmten Bedingung ausgegeben wird, wird die Bedingung dahinter kursiv und in Klammern notiert.

Wenn nur ein Befehlsblock und keine Klassen, Funktionen oder Prozeduren dargestellt sind, ist der jeweilige Code zur Behandlung des Form.Load-Ereignisses des einen Formulars einer Windowsanwendung.

Kleinere Codefragmente im Mengentext werden in einen <tt>-Abschnitt eingeschlossen, das heißt, vor dem Code steht <tt> und nach dem Code steht </tt>. <tt> ist besser als <code>, da es in den Codevorlagen die Hintergrundvorlage der Codevorlage annimmt. Beispiel:

So sehen <tt> und <code> aus.

Für die Syntaxhervorhebung verwende ich einfach:

geht einfacher als mit CSS. Hier wurde die Unterschrift mit -- ~~~~ vergessen.

Noch schöner ist die Kombination beider Möglichkeiten: Der folgende Quelltext (Parameter beachten):

{{:Regal:Programmierung: Vorlage:Code |deutsch=1 |lang=VB.NET |coderahmen=1 
|kopf="source lang" in {{Vorlage:Code}} eingebunden
|code=
<source lang=vbnet>
 Dim a As String = InputBox("Sag mal ""Hallo"".")
 If a = "Hallo" Then
     MessageBox.Show("Gut.")
 Else
     MessageBox.Show("Falsch.")
 End If
</source>
|output= 
 Gut. (Falls "Hallo" eingegeben wurde.)
 Falsch. (Andernfalls.)
}}

wird zu dieser Ausgabe:

"source lang" in {{Vorlage:Code}} eingebunden
VB.NET-Quelltext:

 Dim a As String = InputBox("Sag mal ""Hallo"".")
 If a = "Hallo" Then
     MessageBox.Show("Gut.")
 Else
     MessageBox.Show("Falsch.")
 End If

VB.NET-Ausgabe:

Gut. (Falls "Hallo" eingegeben wurde.)
Falsch. (Andernfalls.)

-- Juetho 18:43, 30. Okt. 2009 (CET)