Struktura haseł w dokumentacji

[lekcja] Rozdział 1. Dokument opisuje ogólną strukturę dokumentów zamieszczanych w dokumentacji.

Wprowadzenie

Jednym z celów jakie nam przyświecają jest tworzenie polskiej dokumentacji bibliotek związanych z językami C oraz C++. Należy jednak zauważyć, że nie celujemy tylko i wyłącznie w opis bibliotek standardowych, a więc kluczowym jest zapewnienie jednolitej formy prezentacji dla wszystkich powstających haseł w dokumentacji. Doświadczenie pokazało, że brak oficjalnego dokumentu opisującego strukturę haseł w dokumentacji wymusza niepotrzebnie szereg prac korekcyjnych, spowalniających istotnie proces publikacji nowo opracowanych zagadnień. W niniejszym rozdziale zawarto więc ogólną strukturę dokumentu, jaka jest rekomendowana i jednocześnie wymagana dla większości haseł znajdujących się w dziale dokumentacji.

Przykład

Składnia

#include <...>

//...

Parametry szablonu

Parametr	Opis
...	...
...	...

Parametry makra

Parametr	Opis
...	...
...	...

Argumenty

Argument	Opis
...	...
...	...

Pola struktury

Pole	Opis
...	...
...	...

Pola klasy

Pole	Opis
...	...
...	...

Zwracana wartość

...

Opis szczegółowy

...

Dodatkowe informacje

...

Rzucane wyjątki

...

Wymagania

...

Implementacja

...

Przykład

//...

Standardowe wyjście programu:

...

Zagadnienia powiązane

[docrel list="..."]

Powyższa treść została uzyskana sekwencją następujących znaczników STC:

[h1]Składnia[/h1]
[code src="C++"]#include <...>

//...
[/code]
[h1]Parametry szablonu[/h1]
[csv header]Parametr;Opis;
...;...;
...;...;
[/csv]
[h1]Parametry makra[/h1]
[csv header]Parametr;Opis;
...;...;
...;...;
[/csv]
[h1]Argumenty[/h1]
[csv header]Argument;Opis;
...;...;
...;...;
[/csv]
[h1]Pola struktury[/h1]
[csv header]Pole;Opis;
...;...;
...;...;
[/csv]
[h1]Pola klasy[/h1]
[csv header]Pole;Opis;
...;...;
...;...;
[/csv]
[h1]Zwracana wartość[/h1]
...
[h1]Opis szczegółowy[/h1]
...
[h1]Dodatkowe informacje[/h1]
...
[h1]Rzucane wyjątki[/h1]
...
[h1]Wymagania[/h1]
...
[h1]Implementacja[/h1]
...
[h1]Przykład[/h1]
[code src="C++"]//...
[/code]
Standardowe wyjście programu:
[code]...
[/code]
[h1]Zagadnienia powiązane[/h1]
[docrel list="..."]

Poprzedni dokument	Następny dokument
Dokumentacja	Zasady pisania haseł w dokumentacji

Wszystkie teksty są chronione prawami autorskimi. Kopiowanie lub rozpowszechnianie treści poza niniejszym serwisem jest zabronione.

Powyższe ograniczenie nie dotyczy autora opracowania, któremu przysługuje prawo do rozpowszechniania własnego tekstu wedle własnego uznania.