C++/Dla autorów

< C++

Wstępne uwagiEdytuj

Ten podręcznik nie jest pomyślany, by od zera nauczyć C++. Tak, jak to jest napisane w Jak czytać ten podręcznik, zakładamy, że czytelnik jest mniej więcej zaznajomiony z treścią podręcznika C. Co za tym idzie, nie należy wyjaśniać podstawowych pojęć, jak zmienna, funkcja, plik nagłówkowy, używanie kompilatora. Jeśli już, można krótko przypomnieć te informacje. Motywacją dla takiego postępowania jest, by nie marnować wysiłków na pisanie tego samego dwa razy - jest to oficjalne zalecenie, uzgodnione w dyskusji.

Jak edytować?Edytuj

Jeśli nie masz doświadczenia z serwisami wiki i Wikibooks w szczególności, zachęcamy byś zajrzał do następujących modułów:

Dodawanie nowych rozdziałówEdytuj

Obecny spis treści jest wynikiem dyskusji i konsensusu wśród osób tworzących podręcznik. Jeśli chcesz wprowadzić w nim duże zmiany, lepiej będzie, jeśli najpierw napiszesz o tym na stronie dyskusji podręcznika i spytasz się innych o zdanie.

Zaczynanie nieistniejących rozdziałów (zaznaczonych czerwonymi linkami) jest jak najbardziej ok, ale staraj się dostosować do krótkiej notki zawartej pod owym linkiem.

IndeksEdytuj

Jeśli dopisujesz nowe, istotne pojęcie, umieść je w Indeksie.

SzablonyEdytuj

W podręczniku szeroko używane są następujące szablony:

Szablony te (poza ostatnim) są tylko udogodnieniami i nie ma przymusu ich stosowania.

Kolorowanie i wyróżnienie bloku kodu uzyskujemy przez umieszczenie kodu w tagach source, jak poniżej:
<syntaxhighlight lang="cpp"> int fun(); </syntaxhighlight>

Kopiowanie tekstu z innych stronEdytuj

Nie ma problemu z kopiowaniem tekstu (w tym kodu źródłowego) z innych źródeł na licencji GFDL czy CC-BY-SA - wystarczy napisać w opisie zmian źródło, tak jak wymaga tego licencja. Problemem jest kopiowanie kodu źródłowego na licencji GPL. Obie licencje GNU są niekompatybilne, co oznacza, że takiego kodu nie można kopiować. Oczywiście wszelkie kopiowanie materiałów z innych stron, szczególnie Copyright, jest niedozwolone.

Koordynacja pracEdytuj

Ważna sprawa: jeśli nie możesz znaleźć czegoś w tym podręczniku, nie dodawaj tego do ToDo, nie dopisuj do spisu treści lecz sprawdź tutaj: podręcznik C. Jeśli zaś tego i tu nie ma, możesz spokojnie to dopisać, ewentualnie rozpocznij temat na stronie Dyskusji.

KonwencjeEdytuj

Styl i zasady używane w całym podręczniku zostały poniżej zebrane, z możliwością dodawania komentarzy, wątpliwości i wyjaśnień. Argumentem wybrania danej konwencji może być jej występowanie w większości innych podręczników czy dokumentacji.

  • Nagłówki

Używamy nagłówków w stylu <iostream>, nie używamy wersji: <iostream.h>, pomija ona mechanizm przestrzeni nazw (std::).

  • Kod - wcięcia bloku {}

W drodze Dyskusji przyjęto i stosuje się styl wstawiania nawiasów klamrowych w nowej linii. Wcięcia przyjęto stosować długości 3 spacji.

if (warunek)
{
   wykonaj();
}
  • Kod - odstępy

Często używanym stylem jest wstawianie spacji przed nawiasem, w takich wyrażeniach jak np.:

if (cos)
catch ()
  • Nazewnictwo

Nie jest ani istotna ani narzucona zasada, ale pomoże uzyskać w miarę spójny styl w podręczniku. Podobny styl znajdziemy w innych publikacjach, w razie czego można zgłosić uwagi.

void nazwa_funkcji()
{
   Klasa nazwa_instancji;
   int nazwa_zmiennej;
}
  • return - main

Przeważa styl używania 'return 0' nad 'return EXIT_SUCCESS', pewnie ze względu na charakter programów - prostych przykładów.