Názor k článku
Java zavádza markdown syntax do komentárov od johny - Tak ono se to v C# hlavně nepoužívá...

  • Článek je starý, nové názory již nelze přidávat.
  • 3. 5. 2024 12:02

    johny


    Tak ono se to v C# hlavně nepoužívá jako komentář, jak si autor představuje, ale jako tool/tip...

    Ak sa Vám nepáči slovo (dokumentačný) komentár, tak si berte dokumentačný reťazec. JavaDoc je ekvivalent documentation string v C#.

    JavaDocs/docu­mentation strings sa rozhodne nečítajú výlučne v HTML outpute/tooltipoch, ale často priamo v kóde. Pozriem si napr. zdrojový kód nejakého projektu priamo na Githube, trebárs https://github.com/dotpcap/sharppcap/blob/master/SharpPcap/ARP.cs
    Z dokumentačného reťazca sa dozviem, že PhysicalAddress


    Resolves the MAC address of the specified IP address. The 'DeviceName' propery must be set prior to using this method.


    XML je ve Visual studiu generované, stačí napsat tři lomítka (///) a IDE připraví komplet celé XML...

    Takto to funguje aj v Jave od nepamäti. Tu nejde o jednoduchosť generovania doc stringov, ale o celkovú ergonómiu výsledného kódu, ktorého súčaťou sú aj komentáre/doku­mentačné komentáre.