Skip to main content

What are C# Comments and how to use them in our code

 
Ziggy Rafiq C# Comments Blog Post


C# Comments


Overview
C# Comments are only for you to read, not for the computer to execute. All the comments displayed in the Code Editor are green by default, which makes it easy to identify those lines, and the C# compiler ignores those parts when it runs your program.

Single-line Comments
You can make any line into the single-line comment by starting it with the two forward slash marks //, indicating the remainder of the line is a comment.

Example


End of line comments
The End of line comments is generally used to describe variables and data types.

Example




Multiline Comments (delimited comments)
Multiline Comments begin with an open comment mark /* and end with a lost comment mark */. All the text between the delimiters is ignored by the compiler.

Example Code


Example Code(Header Comments)


XML Comments
In C# we use XML comment on our methods by simply typing /// to get the XML comment.



Comments

Most Viewed Ziggy Rafiq Blog Posts

How to Truncate String in C#

  Overview In today’s post, I am writing about one of the fundamental aspects of C# and as programmers, we should use this approach I have realised throughout my life as a software engineer that not everyone knows the most basic approaches or how to use them efficiently. Truncating a string in C# means reducing the length of a string to a specified number of characters, typically by removing characters from the end of the string. This is often done when a string is too long to be displayed or used in a specific context and needs to be shortened to fit. Ley says if we have a string that is 100 characters long, but we only want to display the first 50 characters, we will truncate the string to a length of 50. There are several ways to truncate a string in C#, including using the Substring method, StringBuilder, and LINQ. A simple example of this is below, we're creating a longString variable with a long string value. We're also defining a maxLength variable with a value of 20...

A Complete Guide to Using GUIDs in C# with Code Examples

  Overview In this post, we are looking at GUIDs (Globally Unique Identifiers), which are widely used in C# for generating unique identifiers for objects, entities, and resources in a system. In this post, we'll explore the basics of GUIDs in C#, their advantages, and how to convert strings to GUIDs. In this post, we have used Guid Generator to create the GUID from the following URL Address https://guidgenerator.com/ What is GUID GUID (Globally Unique Identifier) in C# is a 128-bit value that is used to identify objects, entities, or resources in a unique manner across different systems and applications. It is also known as UUID (Universally Unique Identifier) in some other programming languages.   GUIDs are generated using a combination of unique factors such as the MAC address of the network adapter, the current time and date, and a random number. The resulting GUID is a string of 32 hexadecimal digits separated by hyphens, such as "b86f2096-237a-4059-8329-1bbcea72769b...

Agile Scrum Definitions

  Overview Over the past few years working within the Agile Scrum teams I have seen at some places there are not clear with the basic simple terms of Agile scrum definitions and I thought of writing this blog post based around exampling the simple basic terms definitions we use in Agile Scrum terms. Product Owner The primary decision-maker on the scrum team. Scrum Master Leads the meetings and standups, removes roadblocks and oversees the scrum team. User Story A brief explanation of the who, what and why behind a project. Tasks An item that needs to be completed by a scrum team member. Backlog A repository of the project ideas that may be executed in the future. Blockers Anything that is preventing a team member from completing their work. Minim Viable Product (MVP) A base-level project intended to show proof of concepts. Kanban A visual framework for tracking steps in a process that uses columns and status indicators moving from left (beginning ) t...