CKTIS / C#
comments and documentation: practical reference
comments and documentation: practical reference: Comments are ignored during execution and describe intent, a contract, or the reason for a decision.
Version: C# language and .NET 10 reference runtime
Syntax
// commentsComments are ignored during execution and describe intent, a contract, or the reason for a decision.
Comment why something is done, especially nontrivial constraints and risks.
A comment that repeats code quickly becomes stale and can mislead readers.
XML comments have syntax and can be validated by the compiler.
The complete program actually uses comments and documentation; its exact expected stdout is comments do not execute.
Examples
using System;
using System.Buffers;
using System.Collections.Concurrent;
using System.Collections.Frozen;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Linq.Expressions;
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
using System.Text;
using System.Text.Json;
using System.Text.Json.Nodes;
using System.Text.Json.Serialization;
using System.Text.RegularExpressions;
using System.Threading;
using System.Threading.Channels;
using System.Threading.Tasks;
using Number = System.Int32;
// A line comment explains intent.
/* A block comment can span a region. */
Console.WriteLine("comments do not execute");
Result
comments do not execute
The complete program actually uses `comments and documentation`; its exact expected stdout is `comments do not execute`.