Das Go-Testpaket erwähnt Beispielfunktionen wie folgt:
%Vor%Was ist die Bedeutung und der Anwendungsfall für diese?
Beispielfunktionen sind Verwendungsbeispiele für ein Paket oder Funktionen oder anderen Code, den Sie dokumentieren. Beispielfunktionen werden in das generierte godoc in Quellform eingefügt (während andere Funktionen nicht sind), mit richtiger Formatierung, auch einige Verarbeitung angewendet, zum Beispiel wenn die letzte Zeile der Beispielfunktion eine Ausgabe in folgendem Format enthält:
%Vor%Die letzte Zeile, die die Ausgabe angibt, wird entfernt und in einem separaten Block gerendert, wie hier zu sehen ist: Beispiel (Ausgabe) .
Auch wenn die Ausgabe bereitgestellt wird: das Ausführen der Testsuite des Pakets (z. B. mit go test ) führt auch Beispielfunktionen ohne weitere Anordnung von Ihnen aus, und Go vergleicht die Ausgabe der Beispielfunktion mit der Ausgabe, die im letzten Kommentar angegeben wurde line - das Ergebnis davon bestimmt, ob dieses Beispiel als "test" funktioniert. Wenn Ausgabe nicht in der Beispielfunktion angegeben ist, wird go test nur kompilieren, aber nicht ausführen.
Sieh dir diese Seite an: package godoctricks
Auch ein Blog-Artikel wurde über Beispielfunktionen veröffentlicht: