Úvod HTML CSS PHP MySQL JavaScript
Komentář je část programu, který překladač naprosto ignoruje a nijak neovlivní chod samotného programu.
Psát je můžeme kdekoliv v kódu.
Slouží k popisu třídy, metody, atd. a tím nám pomáhají se v kódu lépe orientovat.

Jazyk C# umožňuje používat ve zdrojovém kódu tři typy komentářů:

  • Jednořádkové
  • Víceřádkové
  • Dokumentační

Jednořádkové komentáře:

K vytvoření komentáře, který zabere pouze jeden řádek použijeme symbol dvou lomítek.
        
  // Toto je jednořádkový komentář 
       

Víceřádkové komentář:

       
/* Toto je víceřádkový komentář */

Dokumentační komentáře:

C# lze pomocí speciálního typu komentářů psát přímo do zdrojového kódu dokumentaci k třídám, jejich metodám a vlastnostem a dalším prvkům. Zapisuje pomocí XML a je oddělena pomocí tří lomítek ///.

Nejpoužívanější XML tagy
c jednoslovné části kódu, názvy metod a vlastností, lze tímto tagem zvýraznit
code text, který představuje více řádek zdrojového kódu
example pro uvedení příkladu použití
exception k uvedení výjimek, které mohou ve třídě nastat
param k popisu parametru
returns popis návratové hodnoty
summary základní informace o třídě, metodě atd.
value popis hodnoty vlastnosti
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace Komentare
{    
/// <summary> /// Třída k demonstraci dokumentáčních komentářů. /// </summary>
class Vypocet { private int cisloA; private int cisloB; private int cisloC;
/// <value> /// čísloA /// </value>
public int CisloA { get { return cisloA; } set { cisloA = value; } }
/// <value> /// čísloB /// </value>
public int CisloB { get { return cisloB; } set { cisloB = value; } }
/// <value> /// čísloC /// </value>
public int CisloC { get { return cisloC; } set { cisloC = value; } }
/// <summary> /// Konstruktor <c>Vypocet</c> ocekavajici číslo /// <example> /// Celý konstruktor /// <code> /// public Vypocet(int cisloA) /// { /// this.cisloA = cisloA; /// } /// </code> /// </example> /// </summary> /// <param name="cisloA">číslo typu int</param>
public Vypocet(int cisloA) { this.cisloA = cisloA; }
/// <summary> /// sečte tři čísla /// </summary> /// <param name="cisloB">čísloB</param> /// <returns>součet číslaA+číslaB+číslaC</returns> /// <exception cref="ArgumentException"> /// Popis vyjímky /// </exception>
public int secti(int cisloB) { return cisloA + cisloB + cisloC; } } }
pravy Ascii tabulka
Barvy
Klávesové zkratky


©2013-2021 Trojklik.8u.cz Autor: Vašek D.