Mureakuha

Teknisistä rajoituksista johtuen artikkelin yllä näkyvä otsikko on virheellinen. Oikea otsikko on C#-opas: Kommentointi.

Kommentointi

C# käyttää muiden .NET kielten tapaan xml muotoista kommentointia. käytettäviä tageja ovat.

• Tarpeellisimmat
• summary //Johon kuvaus kirjoitetaan.
• param name='muuttuja' //parametrin kommentointi
• returns //paluu arvon kommentointi

• Muita
• c //sanan korostus
• code //koodi esimerkki
• example //esimerkki
• exception //Exception luokan kuvaus. Kääntäjä tekee tarkistuksia myös.
• include file='tiedosto.doc' path='Jossain/*' //sisällyttää tiedoston
• list, item //lista ja item listan osat
• paramref //viittaus parametriin
• permission //oikeuksista
• remarks //huomautus
• see //linkki
• seealso //linkki
• value //ominaisuuden kuvaus

REGION

#region 
   koodia tai kommentteja
#endregion

alueen väli voidaan piilottaa. #region tekstin jälkeen rivillä olevasta tulee piilotetun sisällön kuvaus.

Kommentoitu luokka

using System;
#region Alkulöpinät
/// <summary>
/// Tämä on yksinkertainen luokka, jolle on tehty kommentointia
/// vähän miten sattuu. Tarkoituksena kuitenkin esittää miten C#:ssa
/// kommentoidaan koodia ja tehdään siitä documentti.
/// </summary>
#endregion
public class H7
{
	/// <summary>
	/// Main metodi, jossa jotain koodia hieman.
	/// </summary>
	public static void Main()
	{
		H7 h = new H7(45);
		h.ID+= 60;
		Console.WriteLine("{0}",h.ID);
	}
	
	/// <summary>_ID on kokonaisluku tyyppinen arvo,
	/// jolle ei sitten olekkaa mitään tähdempää käyttöä
	/// </summary>
	protected int _ID;
	
	/// <summary>Muodostin asettaa ID:n alku arvon</summary>
	/// <param name="i">i on kokonaisluku</param>
	public H7(int i) { _ID = i; }
	
	///<summary>ID muutto ominaisuus</summary>
	public int ID
	{
		get { return _ID; }
		set { _ID = value;}
	}
	
	/// <summary>Ensimmäinen metodi, joka jotain palauttaa</summary>
	/// <returns>Palauttaa id:n tekstinä</returns>
	public string getID()
	{
		return _ID.ToString();
	}
}