{"id":151,"date":"2024-10-15T03:34:17","date_gmt":"2024-10-15T03:34:17","guid":{"rendered":"https:\/\/itsmycode.com\/?p=151"},"modified":"2024-10-15T03:34:17","modified_gmt":"2024-10-15T03:34:17","slug":"python-comment-block","status":"publish","type":"post","link":"https:\/\/itsmycode.com\/python-comment-block\/","title":{"rendered":"Python Comment Block"},"content":{"rendered":"\n

Comments are a piece of text in a computer program that provides more information on the source code written. Like every other programming language, Python has three different types of comments: single-line comments, multiline comments, and documentation string to comment out block of code.<\/p>\n\n\n\n

Introduction to Python Comment Block<\/h2>\n\n\n\n

Comments are used to explain the source code. Comments are mainly used for the following purposes.<\/p>\n\n\n\n

    \n
  1. Improve Code readability<\/li>\n\n\n\n
  2. Testing the code<\/li>\n\n\n\n
  3. Explaining the code or Metadata of the project<\/li>\n\n\n\n
  4. Prevent execution of specific code blocks<\/li>\n<\/ol>\n\n\n\n

    For example, let\u2019s say you have written complex business logic, formulas, algorithms, etc. Then we need to document it using the comments that explain what the code does, thus improving the readability of the code in Python.<\/p>\n\n\n\n

    Python interpreter ignores the comments while executing the code and only interprets the code.<\/p>\n\n\n\n

    Types of comments in Python<\/h2>\n\n\n\n

    There are three kinds of comments we can use in Python. <\/p>\n\n\n\n

      \n
    1. Single-line comments<\/strong><\/li>\n\n\n\n
    2. Multiline comments<\/strong><\/li>\n\n\n\n
    3. Documentation strings, aka docstrings<\/strong><\/li>\n<\/ol>\n\n\n\n

      Let us look into details on how to use these comments in Python code with examples.<\/p>\n\n\n\n

      Single-line comments<\/h2>\n\n\n\n

      Single-line comments, also called block comments, start with a hash sign (#) followed by a single space and a text string.<\/p>\n\n\n\n

      The hash (#) works with only a single line of code and not on multi-line code. <\/p>\n\n\n\n

      Let\u2019s take an example to demonstrate single-line comments in Python.<\/p>\n\n\n\n

      Example of Single-line comment in Python<\/strong><\/p>\n\n\n\n

      # This is a single line comment example\nprint(\"Hello World\")<\/code><\/pre>\n\n\n\n
      Inline comments<\/h2>\n\n\n\n
      If you place the comment in the same line as a statement, you will have an inline comment.<\/p>\n\n\n\n
      Like single-line comments, inline comments also begin with a hash (#) sign and are followed by a space and the comment text. <\/p>\n\n\n\n
      Let\u2019s take an example to demonstrate inline comments in Python.<\/p>\n\n\n\n
      Python Inline comments<\/strong><\/p>\n\n\n\n
      print(\"Hello World\") # This is a example of inline comment<\/code><\/pre>\n\n\n\n
      Multiline comments<\/h2>\n\n\n\n
      Usually, in other languages like Go<\/a>, C, C#, Java, etc., we can write <\/a>a multi-line comment as shown below.<\/p>\n\n\n\n
      \/* This is a comment block\nwhich supports\nMulti-line code *\/<\/code><\/pre>\n\n\n\n
      But in Python Multiline comments do not exist built-in like other programming languages.<\/p>\n\n\n\n
      Python may not have any built-in mechanism for commenting out multiple lines. However, there are different ways to achieve this in Python.<\/p>\n\n\n\n
      Using Multiple Hashtags (#)<\/h3>\n\n\n\n
      We can use multiple hashtags to write multiline comments in Python. Each line that has a hash sign(#) is considered as a single-line comment.<\/p>\n\n\n\n
      Multi-line comments Example<\/strong><\/p>\n\n\n\n
      # This is how we can acheive \n# Multi-line comments in Python\nprint(\"Hello World\")<\/code><\/pre>\n\n\n\n
      Python docstrings<\/h2>\n\n\n\n
      Documentation strings, also called docstrings, are the string literal<\/a> denoted with triple quotes that occur as the first statement in a module, function, class, or method definition. Conventions for writing good documentation strings (a.k.a. \u201cdocstrings\u201d) are immortalized in P<\/a>E<\/a>P 257<\/a>.<\/p>\n\n\n\n
      Note:<\/strong> We can also use triple \"\"\"<\/code><\/strong> quotations to create docstrings.<\/pre>\n\n\n\n
      Single line docstrings<\/h3>\n\n\n\n
      Let\u2019s take an example to demonstrate single line docstring.<\/p>\n\n\n\n
      Python Docstrings Example<\/strong><\/p>\n\n\n\n
      def Add(a,b):\n    '''Takes two number as input and returns sum of 2 numbers'''\n    return a+b<\/code><\/pre>\n\n\n\n
      Inside the triple quotation marks is the docstring<\/strong> of the function Add() as it appears right after its definition.<\/p>\n\n\n\n
      Multi-line docstrings<\/h3>\n\n\n\n
      The multi-line docstring can span across multiple lines of code starts with triple quotes(\"\"\"<\/code><\/strong>) and ends with triple quotes (\"\"\"<\/code><\/strong>).<\/p>\n\n\n\n
      We can use multiline docstring as multiline comments in Python to comment out block of code. The creator of Python, Guido Van Rossum, also recommended this and mentioned it on Twitter as a Pro-tip.<\/p>\n\n\n\n
      \n
      @BSUCSClub<\/a> Python tip: You can use multi-line strings as multi-line comments. Unless used as docstrings, they generate no code! \ud83d\ude42\u2014 Guido van Rossum (@gvanrossum) September 10, 2011<\/a><\/p>\n<\/blockquote>\n\n\n\n
      The following example shows you how to use multi-line docstrings. Make sure to indent the leading '''<\/code> appropriately to avoid an IndentationError<\/strong><\/a><\/code><\/p>\n\n\n\n
      Multiline docstring example<\/strong><\/p>\n\n\n\n
      def Add(a,b):\n    '''Takes two number as input \n     Adds a and b\n     Returns sum of a and b as output\n    '''\n    return a+b\n\nprint(Add(5,6))<\/code><\/pre>\n\n\n\n
      Note:<\/strong> As long as the string is not assigned to any Python variable, Python will read the code but then ignore it, and you have made a multiline comment.<\/pre>\n","protected":false},"excerpt":{"rendered":"
      Comments are a piece of text in a computer program that provides more information on the source code written. Like every other programming language, Python has three different types of comments: single-line comments, multiline comments, and documentation string to comment out block of code. Introduction to Python Comment Block Comments are used to explain the […]<\/p>\n","protected":false},"author":1,"featured_media":152,"comment_status":"closed","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[16,1],"tags":[],"class_list":["post-151","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-basics","category-python"],"_links":{"self":[{"href":"https:\/\/itsmycode.com\/wp-json\/wp\/v2\/posts\/151","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/itsmycode.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/itsmycode.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/itsmycode.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/itsmycode.com\/wp-json\/wp\/v2\/comments?post=151"}],"version-history":[{"count":1,"href":"https:\/\/itsmycode.com\/wp-json\/wp\/v2\/posts\/151\/revisions"}],"predecessor-version":[{"id":153,"href":"https:\/\/itsmycode.com\/wp-json\/wp\/v2\/posts\/151\/revisions\/153"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/itsmycode.com\/wp-json\/wp\/v2\/media\/152"}],"wp:attachment":[{"href":"https:\/\/itsmycode.com\/wp-json\/wp\/v2\/media?parent=151"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/itsmycode.com\/wp-json\/wp\/v2\/categories?post=151"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/itsmycode.com\/wp-json\/wp\/v2\/tags?post=151"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}