Megosztás a következőn keresztül:

Megjegyzések a Kódban (Visual Basic)

  • Cikk

Amikor elolvassa a példakódokat, gyakran találkozik a megjegyzésszimbólummal ('). Ez a szimbólum arra utasítja a Visual Basic fordítót, hogy hagyja figyelmen kívül az azt követő szöveget vagy a megjegyzést. A megjegyzések rövid magyarázó megjegyzések, amelyek a kódhoz vannak hozzáadva az olvasóik javára.

Jó programozási gyakorlat az eljárásokat egy rövid megjegyzéssel kezdeni, amely leírja az eljárás funkcionális jellemzőit (mit tesz). Ez a saját előnyére szolgál, és mindenki más javára, aki megvizsgálja a kódot. A megvalósítás részleteit (az eljárás menetét) el kell különítse a funkcionális jellemzőket leíró megjegyzésektől. Ha a leírásban szerepel a megvalósítás részleteinek megadása, ne felejtse el frissíteni őket a függvény frissítésekor.

A megjegyzések követhetnek egy utasítást ugyanazon a sorban, vagy elfoglalhatnak egy teljes sort. Mindkettőt az alábbi kód szemlélteti.

' This is a comment beginning at the left edge of the screen.
text1.Text = "Hi!"   ' This is an inline comment.

Ha a megjegyzéshez egynél több sorra van szükség, használja az egyes sorok megjegyzésszimbólumát, ahogyan azt az alábbi példa szemlélteti.

' This comment is too long to fit on a single line, so we break 
' it into two lines. Some comments might need three or more lines.

Megjegyzésekre vonatkozó irányelvek

Az alábbi táblázat általános irányelveket tartalmaz arra vonatkozóan, hogy milyen típusú megjegyzések előzhetik meg a kód egy szakaszát. Ezek javaslatok; A Visual Basic nem kényszeríti ki a megjegyzések hozzáadására vonatkozó szabályokat. Írja meg, mi működik a legjobban önnek és bárki másnak, aki elolvassa a kódot.

Megjegyzés típusa Megjegyzés leírása
Cél Az eljárás leírása (nem az eljárás menete)
Feltételezések Felsorolja az eljárás által elért minden külső változót, vezérlőt, megnyitott fájlt vagy egyéb elemet
Hatások Felsorolja az egyes érintett külső változók, vezérlőelemek vagy fájlok listáját, valamint annak hatását (csak akkor, ha nem nyilvánvaló)
Bevitelek Az argumentum célját határozza meg
Válaszok Az eljárás által visszaadott értékek magyarázata

Jegyezze meg a következő pontokat:

  • Minden fontos változódeklarációt meg kell előznie egy megjegyzésnek, amely leírja a deklarált változó használatát.

  • A változókat, vezérlőket és eljárásokat elég egyértelműen el kell nevezni, hogy csak összetett megvalósítási részletekhez legyen szükség megjegyzésre.

  • A megjegyzések nem követhetők egy sor-folytatás sorozatot ugyanazon a sorban.

Egy kódblokkhoz megjegyzésszimbólumokat adhat hozzá vagy távolíthat el, ha kijelöl egy vagy több sornyi kódot, majd a Szerkesztés eszköztár Megjegyzés (The Visual Basic Comment button in Visual Studio.) és Megjegyzés feloldása (The Visual Basic Uncomment button in Visual Studio.) gombjára kattint.

Feljegyzés

Megjegyzéseket is hozzáadhat a kódhoz úgy, hogy a kulcsszóval együtt előzi meg a REM szöveget. A ' szimbólum és a Megjegyzés/feloldása gomb azonban könnyebben használható, és kevesebb helyet és memóriát igényel.

Lásd még