Zum Inhalt

Codebeispiele

Quelltext kann entweder durch Einrückungen oder durch Hochkammas dargestellt werden.

Erfolgt die Auszeichnung mittels Hochkammas, sollte die zu verwendende Sprache mittels Label nach den Hochkommas angezeigt werden.

```php
```javascript

Bei der Verwendung von Einrückungen, kann die Sprache mittels drei Doppelpunkte markiert werden :::php

Wird keine Sprache ausgewählt, so versucht das Script die Sprache zu erraten. Soll kein Syntaxhervorhebung erfolgen, so muss dies explizit mit nohighlight angegeben werden.

```nohighlight

Dokumentation von Codebeispielen sollte immer auf lauffähigem Code beruhen. Aus diesem Grund sollte ein Programm immer eigenständig entwickelt werden. Die Einbindung erfolgt über diese Markierung:

Beispiel

In dem Beispiel wird die Beispieldatei test.php mit folgendem Code erstellt.

<?php
$a=0;
$a+=1;
echo $a;

Möchte man nun die erste und zweite Zeile in die Dokumentation einfügen und im Anschluß die dritte Zeile, so muss man folgende Markierungen in der Datei einbringen.

<?php

/** EXAMPLE:START **/

/** SNIPPET:PART1:START */

$a=0;
$a+=1;

/** SNIPPET:PART1:END */

/** SNIPPET:PART2:START */

echo $a;

/** SNIPPET:PART2:END */

/** EXAMPLE:END **/

Die Einbindung in die Dokumentation erfolgt dann folgendermaßen:

```php
beispiel1
```

und für den Zweiten Teil

```php
beispiel2
```

Das Ergebnis ist dann:

$a=0;
$a+=1;

und

echo $a;

Tabs

Mittels Tabs lassen sich Beispiele für verschiedene Sprachen in einen Codeblock integrieren.

``` bash tab="Bash"
#!/bin/bash

echo "Hello world!"
```

``` c tab="C"
#include <stdio.h>

int main(void) {
  printf("Hello world!\n");
}
```

``` c++ tab="C++"
#include <iostream>

int main() {
  std::cout << "Hello world!" << std::endl;
  return 0;
}
```

``` c# tab="C#"
using System;

class Program {
  static void Main(string[] args) {
    Console.WriteLine("Hello world!");
  }
}
```
#!/bin/bash

echo "Hello world!"
#include <stdio.h>

int main(void) {
  printf("Hello world!\n");
}
#include <iostream>

int main() {
  std::cout << "Hello world!" << std::endl;
  return 0;
}
using System;

class Program {
  static void Main(string[] args) {
    Console.WriteLine("Hello world!");
  }
}