kódolási szabványok

• Annak jelzésére, benyomódási alkalmazásával 4 terek egy sorban
• Használja szóköz helyett fülek!

• Állapítsa egy változó soronként.
• Kerüljük, ha lehet, a rövid és zavaros változó nevét (például: "a", "rbarr", "nughdeget").
• Single-karakter változó nevek csak alkalmas iterátorokat ciklus, egy kis nyelv- és változókat. Más esetekben a változó nevét kell tükröznie a célját.
• Crank változók csak szükség esetén.

• Függvények és változók neve legyen nagybetűvel, mintha a nevét egy változó vagy függvény épül fel több szóval, az első szó kell kezdeni nagybetűvel, a többi - a kisbetűs.
• Kerüljük a rövidítéseket

• Osztály neveket mindig kezdeni nagybetűvel.

• Az üres sorokat logikai csoportosítása szereplők, amennyiben lehetséges.
• Mindig egy üres sort, mint egy elválasztó
• Mindig használjon előtti tér zárójel

• Mindig fel egy hely után a „*” vagy „” mikor feláll ismertetése előtt típusok. De soha ne tegye egy hely után a „*” vagy „” és a változó neve.

• Bináris műveletek szóközzel vannak elválasztva a 2 stroncium.
• Az átalakítás után típusok ne tegye terek.
• Kerülje típuskonverzió a stílus C.

fogszabályozó

• Vegyük az egyenlege alapján a nyitó zárójelek ugyanabban a sorban a kifejezés, amelyet megelőz

• Kivétel: A funkció és az osztály leírása A test mindig nyitva merevítő, állva egy új sort

• Használja zárójelek szempontjából, ha a feltételek a szervezet, amelynek mértéke több mint egy sorban, vagy kondíció elég nehéz, és a kiválasztási merevítő valóban szüksége van

• Kivétel 1: zárójelek, ha a szülő kifejezése áll, több vonal / pakolások

• Kivétel 2: A nadrágtartó, amikor a test elágazás if-then-else, hogy egy pár sort

• Használja nadrágtartó határozni azokat a feltételeket az üres test

zárójelben

• A zárójelek csoportba kifejezések:

Használata konstrukciók kapcsoló

törésvonalak

• kódsor nem haladhatja meg a 80 karaktert. Ha szükséges - használja a sortörés.
• A vesszők végén elhelyezett, a szaggatott vonal; szereplők kerülnek elején egy új sort. Attól függően, hogy az IDE akkor az üzemeltető a végén a szaggatott vonal lehet figyelmen kívül hagyni.

Öröklés és virtuális kulcsszó

• Amikor felülírják virtuális módszer, ne tegye a szót virtuális a header fájlban.

Hogyan kell használni

Hogyan hozhatok létre html

Ön most létrehozott egy fájlt dokumentumokat.

Létrehozása konfigurációs fájl

Amikor először hozzon létre egy fájlt a dokumentáció, akkor létre kell hozni egy fájlt - konfigurációs adattár. Ehhez

szerkesztés Doxyfile

Ha szükséges, szerkessze Doxyfile

• vagy F4

• segédprogram grafikus felület - erre a parancssorban

generálása dokumentáció

Ezután kezdeni dokumentáció

• vagy a parancssorból:

• segédprogram grafikus felületet egy gombra, hasonlóan a hajtómű - erre a parancssorban

Szeretné frissíteni a dokumentáció a fájlt, ami már van, de elavult. A parancssorban (a könyvtárban, ahol a Doxyfile):

Megjegyzések a dokumentáció kivitelezés

A dokumentum a következő osztályok, az osztály tagjai és funkciók az összes lehetőséget. Ezen túlmenően, az egyes modulok egészében dokumentálni kell, hogyan kell használni őket.

dokumentálása az osztályok

dokumentáló funkciók

dokumentáló modulok

Mindenesetre kód

különböző dolog

• A szöveg a honlapon - @mainpage

• Létre egy új oldalt - @ Page azonosító neve

Például @ Page pagereq rendszerkövetelmények

• Létrehozása szakasz - @section azonosító neve

Például @section közös általános követelmények

• Helyezze be a minta kódot - @code

Ez a címke pár bezárja @endcode

• Rövid leírás - @brief

Itt lehet beállítani a beállítási fájlban, hogy a rövid leírást hozott az első ajánlatot, hogy a pont a részletes leírást (alapértelmezett tartják a részletes leírást). Ehhez kapcsolja be a lehetőséget JAVADOC_AUTOBRIEF - Utility doxywizard ez az első oldalon.

Ezután, hogy a csoport a zárójelben @<… @> Például, így lehet csoportosítani osztály módszerek:

• Ne félj, hogy megtörjük a fent leírt szabályok, ha úgy tűnik, hogy csak megzavarja a kódot.