CINXE.COM

<!DOCTYPE html> <html class="client-nojs vector-feature-language-in-header-enabled vector-feature-language-in-main-page-header-disabled vector-feature-sticky-header-disabled vector-feature-page-tools-pinned-disabled vector-feature-toc-pinned-clientpref-1 vector-feature-main-menu-pinned-disabled vector-feature-limited-width-clientpref-1 vector-feature-limited-width-content-enabled vector-feature-custom-font-size-clientpref-1 vector-feature-appearance-pinned-clientpref-1 vector-feature-night-mode-enabled skin-theme-clientpref-day vector-toc-available" lang="en" dir="ltr"> <head> <meta charset="UTF-8"> <title>Comment (computer programming) - Wikipedia</title> <script>(function(){var className="client-js vector-feature-language-in-header-enabled vector-feature-language-in-main-page-header-disabled vector-feature-sticky-header-disabled vector-feature-page-tools-pinned-disabled vector-feature-toc-pinned-clientpref-1 vector-feature-main-menu-pinned-disabled vector-feature-limited-width-clientpref-1 vector-feature-limited-width-content-enabled vector-feature-custom-font-size-clientpref-1 vector-feature-appearance-pinned-clientpref-1 vector-feature-night-mode-enabled skin-theme-clientpref-day vector-toc-available";var cookie=document.cookie.match(/(?:^|; )enwikimwclientpreferences=([^;]+)/);if(cookie){cookie[1].split('%2C').forEach(function(pref){className=className.replace(new RegExp('(^| )'+pref.replace(/-clientpref-\w+$|[^\w-]+/g,'')+'-clientpref-\\w+( |$)'),'$1'+pref+'$2');});}document.documentElement.className=className;}());RLCONF={"wgBreakFrames":false,"wgSeparatorTransformTable":["",""],"wgDigitTransformTable":["",""],"wgDefaultDateFormat":"dmy", "wgMonthNames":["","January","February","March","April","May","June","July","August","September","October","November","December"],"wgRequestId":"504d35c3-7b17-4bed-a110-4de98a863553","wgCanonicalNamespace":"","wgCanonicalSpecialPageName":false,"wgNamespaceNumber":0,"wgPageName":"Comment_(computer_programming)","wgTitle":"Comment (computer programming)","wgCurRevisionId":1258397066,"wgRevisionId":1258397066,"wgArticleId":8592308,"wgIsArticle":true,"wgIsRedirect":false,"wgAction":"view","wgUserName":null,"wgUserGroups":["*"],"wgCategories":["Articles with short description","Short description is different from Wikidata","Articles with example code","Articles with example C code","Articles with example Java code","Articles with example Perl code","Source code","Metadata"],"wgPageViewLanguage":"en","wgPageContentLanguage":"en","wgPageContentModel":"wikitext","wgRelevantPageName":"Comment_(computer_programming)","wgRelevantArticleId":8592308,"wgIsProbablyEditable":true, "wgRelevantPageIsProbablyEditable":true,"wgRestrictionEdit":[],"wgRestrictionMove":[],"wgRedirectedFrom":"REM_(DOS_command)","wgNoticeProject":"wikipedia","wgCiteReferencePreviewsActive":false,"wgFlaggedRevsParams":{"tags":{"status":{"levels":1}}},"wgMediaViewerOnClick":true,"wgMediaViewerEnabledByDefault":true,"wgPopupsFlags":0,"wgVisualEditor":{"pageLanguageCode":"en","pageLanguageDir":"ltr","pageVariantFallbacks":"en"},"wgMFDisplayWikibaseDescriptions":{"search":true,"watchlist":true,"tagline":false,"nearby":true},"wgWMESchemaEditAttemptStepOversample":false,"wgWMEPageLength":60000,"wgInternalRedirectTargetUrl":"/wiki/Comment_(computer_programming)","wgRelatedArticlesCompat":[],"wgCentralAuthMobileDomain":false,"wgEditSubmitButtonLabelPublish":true,"wgULSPosition":"interlanguage","wgULSisCompactLinksEnabled":false,"wgVector2022LanguageInHeader":true,"wgULSisLanguageSelectorEmpty":false,"wgWikibaseItemId":"Q1141067","wgCheckUserClientHintsHeadersJsApi":["brands","architecture", "bitness","fullVersionList","mobile","model","platform","platformVersion"],"GEHomepageSuggestedEditsEnableTopics":true,"wgGETopicsMatchModeEnabled":false,"wgGEStructuredTaskRejectionReasonTextInputEnabled":false,"wgGELevelingUpEnabledForUser":false};RLSTATE={"ext.globalCssJs.user.styles":"ready","site.styles":"ready","user.styles":"ready","ext.globalCssJs.user":"ready","user":"ready","user.options":"loading","ext.cite.styles":"ready","ext.pygments":"ready","skins.vector.search.codex.styles":"ready","skins.vector.styles":"ready","skins.vector.icons":"ready","ext.wikimediamessages.styles":"ready","ext.visualEditor.desktopArticleTarget.noscript":"ready","ext.uls.interlanguage":"ready","wikibase.client.init":"ready","ext.wikimediaBadges":"ready"};RLPAGEMODULES=["mediawiki.action.view.redirect","ext.cite.ux-enhancements","ext.pygments.view","mediawiki.page.media","site","mediawiki.page.ready","mediawiki.toc","skins.vector.js","ext.centralNotice.geoIP","ext.centralNotice.startUp", "ext.gadget.ReferenceTooltips","ext.gadget.switcher","ext.urlShortener.toolbar","ext.centralauth.centralautologin","mmv.bootstrap","ext.popups","ext.visualEditor.desktopArticleTarget.init","ext.visualEditor.targetLoader","ext.echo.centralauth","ext.eventLogging","ext.wikimediaEvents","ext.navigationTiming","ext.uls.interface","ext.cx.eventlogging.campaigns","ext.cx.uls.quick.actions","wikibase.client.vector-2022","ext.checkUser.clientHints","ext.quicksurveys.init","ext.growthExperiments.SuggestedEditSession","wikibase.sidebar.tracking"];</script> <script>(RLQ=window.RLQ||[]).push(function(){mw.loader.impl(function(){return["user.options@12s5i",function($,jQuery,require,module){mw.user.tokens.set({"patrolToken":"+\\","watchToken":"+\\","csrfToken":"+\\"}); }];});});</script> <link rel="stylesheet" href="/w/load.php?lang=en&modules=ext.cite.styles%7Cext.pygments%2CwikimediaBadges%7Cext.uls.interlanguage%7Cext.visualEditor.desktopArticleTarget.noscript%7Cext.wikimediamessages.styles%7Cskins.vector.icons%2Cstyles%7Cskins.vector.search.codex.styles%7Cwikibase.client.init&only=styles&skin=vector-2022"> <script async="" src="/w/load.php?lang=en&modules=startup&only=scripts&raw=1&skin=vector-2022"></script> <meta name="ResourceLoaderDynamicStyles" content=""> <link rel="stylesheet" href="/w/load.php?lang=en&modules=site.styles&only=styles&skin=vector-2022"> <meta name="generator" content="MediaWiki 1.44.0-wmf.4"> <meta name="referrer" content="origin"> <meta name="referrer" content="origin-when-cross-origin"> <meta name="robots" content="max-image-preview:standard"> <meta name="format-detection" content="telephone=no"> <meta property="og:image" content="https://upload.wikimedia.org/wikipedia/commons/thumb/7/75/CodeCmmt002.svg/1200px-CodeCmmt002.svg.png"> <meta property="og:image:width" content="1200"> <meta property="og:image:height" content="1075"> <meta property="og:image" content="https://upload.wikimedia.org/wikipedia/commons/thumb/7/75/CodeCmmt002.svg/800px-CodeCmmt002.svg.png"> <meta property="og:image:width" content="800"> <meta property="og:image:height" content="717"> <meta property="og:image" content="https://upload.wikimedia.org/wikipedia/commons/thumb/7/75/CodeCmmt002.svg/640px-CodeCmmt002.svg.png"> <meta property="og:image:width" content="640"> <meta property="og:image:height" content="573"> <meta name="viewport" content="width=1120"> <meta property="og:title" content="Comment (computer programming) - Wikipedia"> <meta property="og:type" content="website"> <link rel="preconnect" href="//upload.wikimedia.org"> <link rel="alternate" media="only screen and (max-width: 640px)" href="//en.m.wikipedia.org/wiki/Comment_(computer_programming)"> <link rel="alternate" type="application/x-wiki" title="Edit this page" href="/w/index.php?title=Comment_(computer_programming)&action=edit"> <link rel="apple-touch-icon" href="/static/apple-touch/wikipedia.png"> <link rel="icon" href="/static/favicon/wikipedia.ico"> <link rel="search" type="application/opensearchdescription+xml" href="/w/rest.php/v1/search" title="Wikipedia (en)"> <link rel="EditURI" type="application/rsd+xml" href="//en.wikipedia.org/w/api.php?action=rsd"> <link rel="canonical" href="https://en.wikipedia.org/wiki/Comment_(computer_programming)"> <link rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/deed.en"> <link rel="alternate" type="application/atom+xml" title="Wikipedia Atom feed" href="/w/index.php?title=Special:RecentChanges&feed=atom"> <link rel="dns-prefetch" href="//meta.wikimedia.org" /> <link rel="dns-prefetch" href="//login.wikimedia.org"> </head> <body class="skin--responsive skin-vector skin-vector-search-vue mediawiki ltr sitedir-ltr mw-hide-empty-elt ns-0 ns-subject mw-editable page-Comment_computer_programming rootpage-Comment_computer_programming skin-vector-2022 action-view"><a class="mw-jump-link" href="#bodyContent">Jump to content</a> <div class="vector-header-container"> <header class="vector-header mw-header"> <div class="vector-header-start"> <nav class="vector-main-menu-landmark" aria-label="Site"> <div id="vector-main-menu-dropdown" class="vector-dropdown vector-main-menu-dropdown vector-button-flush-left vector-button-flush-right" > <input type="checkbox" id="vector-main-menu-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-main-menu-dropdown" class="vector-dropdown-checkbox " aria-label="Main menu" > <label id="vector-main-menu-dropdown-label" for="vector-main-menu-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" > Main menu </label> <div class="vector-dropdown-content"> <div id="vector-main-menu-unpinned-container" class="vector-unpinned-container"> <div id="vector-main-menu" class="vector-main-menu vector-pinnable-element"> <div class="vector-pinnable-header vector-main-menu-pinnable-header vector-pinnable-header-unpinned" data-feature-name="main-menu-pinned" data-pinnable-element-id="vector-main-menu" data-pinned-container-id="vector-main-menu-pinned-container" data-unpinned-container-id="vector-main-menu-unpinned-container" > <div class="vector-pinnable-header-label">Main menu</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-main-menu.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-main-menu.unpin">hide</button> </div> <div id="p-navigation" class="vector-menu mw-portlet mw-portlet-navigation" > <div class="vector-menu-heading"> Navigation </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="n-mainpage-description" class="mw-list-item"><a href="/wiki/Main_Page" title="Visit the main page [z]" accesskey="z">Main page</a></li><li id="n-contents" class="mw-list-item"><a href="/wiki/Wikipedia:Contents" title="Guides to browsing Wikipedia">Contents</a></li><li id="n-currentevents" class="mw-list-item"><a href="/wiki/Portal:Current_events" title="Articles related to current events">Current events</a></li><li id="n-randompage" class="mw-list-item"><a href="/wiki/Special:Random" title="Visit a randomly selected article [x]" accesskey="x">Random article</a></li><li id="n-aboutsite" class="mw-list-item"><a href="/wiki/Wikipedia:About" title="Learn about Wikipedia and how it works">About Wikipedia</a></li><li id="n-contactpage" class="mw-list-item"><a href="//en.wikipedia.org/wiki/Wikipedia:Contact_us" title="How to contact Wikipedia">Contact us</a></li> </ul> </div> </div> <div id="p-interaction" class="vector-menu mw-portlet mw-portlet-interaction" > <div class="vector-menu-heading"> Contribute </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="n-help" class="mw-list-item"><a href="/wiki/Help:Contents" title="Guidance on how to use and edit Wikipedia">Help</a></li><li id="n-introduction" class="mw-list-item"><a href="/wiki/Help:Introduction" title="Learn how to edit Wikipedia">Learn to edit</a></li><li id="n-portal" class="mw-list-item"><a href="/wiki/Wikipedia:Community_portal" title="The hub for editors">Community portal</a></li><li id="n-recentchanges" class="mw-list-item"><a href="/wiki/Special:RecentChanges" title="A list of recent changes to Wikipedia [r]" accesskey="r">Recent changes</a></li><li id="n-upload" class="mw-list-item"><a href="/wiki/Wikipedia:File_upload_wizard" title="Add images or other media for use on Wikipedia">Upload file</a></li> </ul> </div> </div> </div> </div> </div> </div> </nav> <a href="/wiki/Main_Page" class="mw-logo"> <img class="mw-logo-icon" src="/static/images/icons/wikipedia.png" alt="" aria-hidden="true" height="50" width="50"> <img class="mw-logo-wordmark" alt="Wikipedia" src="/static/images/mobile/copyright/wikipedia-wordmark-en.svg" style="width: 7.5em; height: 1.125em;"> <img class="mw-logo-tagline" alt="The Free Encyclopedia" src="/static/images/mobile/copyright/wikipedia-tagline-en.svg" width="117" height="13" style="width: 7.3125em; height: 0.8125em;"> </a> </div> <div class="vector-header-end"> <div id="p-search" role="search" class="vector-search-box-vue vector-search-box-collapses vector-search-box-show-thumbnail vector-search-box-auto-expand-width vector-search-box"> <a href="/wiki/Special:Search" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only search-toggle" title="Search Wikipedia [f]" accesskey="f"> Search </a> <div class="vector-typeahead-search-container"> <div class="cdx-typeahead-search cdx-typeahead-search--show-thumbnail cdx-typeahead-search--auto-expand-width"> <form action="/w/index.php" id="searchform" class="cdx-search-input cdx-search-input--has-end-button"> <div id="simpleSearch" class="cdx-search-input__input-wrapper" data-search-loc="header-moved"> <div class="cdx-text-input cdx-text-input--has-start-icon"> <input class="cdx-text-input__input" type="search" name="search" placeholder="Search Wikipedia" aria-label="Search Wikipedia" autocapitalize="sentences" title="Search Wikipedia [f]" accesskey="f" id="searchInput" > </div> <input type="hidden" name="title" value="Special:Search"> </div> <button class="cdx-button cdx-search-input__end-button">Search</button> </form> </div> </div> </div> <nav class="vector-user-links vector-user-links-wide" aria-label="Personal tools"> <div class="vector-user-links-main"> <div id="p-vector-user-menu-preferences" class="vector-menu mw-portlet emptyPortlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> <div id="p-vector-user-menu-userpage" class="vector-menu mw-portlet emptyPortlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> <nav class="vector-appearance-landmark" aria-label="Appearance"> <div id="vector-appearance-dropdown" class="vector-dropdown " title="Change the appearance of the page's font size, width, and color" > <input type="checkbox" id="vector-appearance-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-appearance-dropdown" class="vector-dropdown-checkbox " aria-label="Appearance" > <label id="vector-appearance-dropdown-label" for="vector-appearance-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" > Appearance </label> <div class="vector-dropdown-content"> <div id="vector-appearance-unpinned-container" class="vector-unpinned-container"> </div> </div> </div> </nav> <div id="p-vector-user-menu-notifications" class="vector-menu mw-portlet emptyPortlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> <div id="p-vector-user-menu-overflow" class="vector-menu mw-portlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="pt-sitesupport-2" class="user-links-collapsible-item mw-list-item user-links-collapsible-item"><a data-mw="interface" href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector?utm_source=donate&utm_medium=sidebar&utm_campaign=C13_en.wikipedia.org&uselang=en" class="">Donate</a> </li> <li id="pt-createaccount-2" class="user-links-collapsible-item mw-list-item user-links-collapsible-item"><a data-mw="interface" href="/w/index.php?title=Special:CreateAccount&returnto=Comment+%28computer+programming%29" title="You are encouraged to create an account and log in; however, it is not mandatory" class="">Create account</a> </li> <li id="pt-login-2" class="user-links-collapsible-item mw-list-item user-links-collapsible-item"><a data-mw="interface" href="/w/index.php?title=Special:UserLogin&returnto=Comment+%28computer+programming%29" title="You're encouraged to log in; however, it's not mandatory. [o]" accesskey="o" class="">Log in</a> </li> </ul> </div> </div> </div> <div id="vector-user-links-dropdown" class="vector-dropdown vector-user-menu vector-button-flush-right vector-user-menu-logged-out" title="Log in and more options" > <input type="checkbox" id="vector-user-links-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-user-links-dropdown" class="vector-dropdown-checkbox " aria-label="Personal tools" > <label id="vector-user-links-dropdown-label" for="vector-user-links-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" > Personal tools </label> <div class="vector-dropdown-content"> <div id="p-personal" class="vector-menu mw-portlet mw-portlet-personal user-links-collapsible-item" title="User menu" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="pt-sitesupport" class="user-links-collapsible-item mw-list-item"><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector?utm_source=donate&utm_medium=sidebar&utm_campaign=C13_en.wikipedia.org&uselang=en">Donate</a></li><li id="pt-createaccount" class="user-links-collapsible-item mw-list-item"><a href="/w/index.php?title=Special:CreateAccount&returnto=Comment+%28computer+programming%29" title="You are encouraged to create an account and log in; however, it is not mandatory"> Create account</a></li><li id="pt-login" class="user-links-collapsible-item mw-list-item"><a href="/w/index.php?title=Special:UserLogin&returnto=Comment+%28computer+programming%29" title="You're encouraged to log in; however, it's not mandatory. [o]" accesskey="o"> Log in</a></li> </ul> </div> </div> <div id="p-user-menu-anon-editor" class="vector-menu mw-portlet mw-portlet-user-menu-anon-editor" > <div class="vector-menu-heading"> Pages for logged out editors <a href="/wiki/Help:Introduction" aria-label="Learn more about editing">learn more</a> </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="pt-anoncontribs" class="mw-list-item"><a href="/wiki/Special:MyContributions" title="A list of edits made from this IP address [y]" accesskey="y">Contributions</a></li><li id="pt-anontalk" class="mw-list-item"><a href="/wiki/Special:MyTalk" title="Discussion about edits from this IP address [n]" accesskey="n">Talk</a></li> </ul> </div> </div> </div> </div> </nav> </div> </header> </div> <div class="mw-page-container"> <div class="mw-page-container-inner"> <div class="vector-sitenotice-container"> <div id="siteNotice"></div> </div> <div class="vector-column-start"> <div class="vector-main-menu-container"> <div id="mw-navigation"> <nav id="mw-panel" class="vector-main-menu-landmark" aria-label="Site"> <div id="vector-main-menu-pinned-container" class="vector-pinned-container"> </div> </nav> </div> </div> <div class="vector-sticky-pinned-container"> <nav id="mw-panel-toc" aria-label="Contents" data-event-name="ui.sidebar-toc" class="mw-table-of-contents-container vector-toc-landmark"> <div id="vector-toc-pinned-container" class="vector-pinned-container"> <div id="vector-toc" class="vector-toc vector-pinnable-element"> <div class="vector-pinnable-header vector-toc-pinnable-header vector-pinnable-header-pinned" data-feature-name="toc-pinned" data-pinnable-element-id="vector-toc" > <h2 class="vector-pinnable-header-label">Contents</h2> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-toc.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-toc.unpin">hide</button> </div> <ul class="vector-toc-contents" id="mw-panel-toc-list"> <li id="toc-mw-content-text" class="vector-toc-list-item vector-toc-level-1"> <a href="#" class="vector-toc-link"> <div class="vector-toc-text">(Top)</div> </a> </li> <li id="toc-Overview" class="vector-toc-list-item vector-toc-level-1"> <a class="vector-toc-link" href="#Overview"> <div class="vector-toc-text"> 1 Overview </div> </a> <ul id="toc-Overview-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Uses" class="vector-toc-list-item vector-toc-level-1"> <a class="vector-toc-link" href="#Uses"> <div class="vector-toc-text"> 2 Uses </div> </a> <button aria-controls="toc-Uses-sublist" class="cdx-button cdx-button--weight-quiet cdx-button--icon-only vector-toc-toggle"> Toggle Uses subsection </button> <ul id="toc-Uses-sublist" class="vector-toc-list"> <li id="toc-Planning_and_reviewing" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Planning_and_reviewing"> <div class="vector-toc-text"> 2.1 Planning and reviewing </div> </a> <ul id="toc-Planning_and_reviewing-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Code_description" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Code_description"> <div class="vector-toc-text"> 2.2 Code description </div> </a> <ul id="toc-Code_description-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Algorithmic_description" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Algorithmic_description"> <div class="vector-toc-text"> 2.3 Algorithmic description </div> </a> <ul id="toc-Algorithmic_description-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Resource_inclusion" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Resource_inclusion"> <div class="vector-toc-text"> 2.4 Resource inclusion </div> </a> <ul id="toc-Resource_inclusion-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Metadata" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Metadata"> <div class="vector-toc-text"> 2.5 Metadata </div> </a> <ul id="toc-Metadata-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Debugging" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Debugging"> <div class="vector-toc-text"> 2.6 Debugging </div> </a> <ul id="toc-Debugging-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Automatic_documentation_generation" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Automatic_documentation_generation"> <div class="vector-toc-text"> 2.7 Automatic documentation generation </div> </a> <ul id="toc-Automatic_documentation_generation-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Syntax_extension" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Syntax_extension"> <div class="vector-toc-text"> 2.8 Syntax extension </div> </a> <ul id="toc-Syntax_extension-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Directive_uses" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Directive_uses"> <div class="vector-toc-text"> 2.9 Directive uses </div> </a> <ul id="toc-Directive_uses-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Stress_relief" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Stress_relief"> <div class="vector-toc-text"> 2.10 Stress relief </div> </a> <ul id="toc-Stress_relief-sublist" class="vector-toc-list"> </ul> </li> </ul> </li> <li id="toc-Normative_views" class="vector-toc-list-item vector-toc-level-1"> <a class="vector-toc-link" href="#Normative_views"> <div class="vector-toc-text"> 3 Normative views </div> </a> <button aria-controls="toc-Normative_views-sublist" class="cdx-button cdx-button--weight-quiet cdx-button--icon-only vector-toc-toggle"> Toggle Normative views subsection </button> <ul id="toc-Normative_views-sublist" class="vector-toc-list"> <li id="toc-Need_for_comments" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Need_for_comments"> <div class="vector-toc-text"> 3.1 Need for comments </div> </a> <ul id="toc-Need_for_comments-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Level_of_detail" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Level_of_detail"> <div class="vector-toc-text"> 3.2 Level of detail </div> </a> <ul id="toc-Level_of_detail-sublist" class="vector-toc-list"> </ul> </li> </ul> </li> <li id="toc-Styles" class="vector-toc-list-item vector-toc-level-1"> <a class="vector-toc-link" href="#Styles"> <div class="vector-toc-text"> 4 Styles </div> </a> <button aria-controls="toc-Styles-sublist" class="cdx-button cdx-button--weight-quiet cdx-button--icon-only vector-toc-toggle"> Toggle Styles subsection </button> <ul id="toc-Styles-sublist" class="vector-toc-list"> <li id="toc-Block_comment" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Block_comment"> <div class="vector-toc-text"> 4.1 Block comment </div> </a> <ul id="toc-Block_comment-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Line_comments" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Line_comments"> <div class="vector-toc-text"> 4.2 Line comments </div> </a> <ul id="toc-Line_comments-sublist" class="vector-toc-list"> </ul> </li> </ul> </li> <li id="toc-Tags" class="vector-toc-list-item vector-toc-level-1"> <a class="vector-toc-link" href="#Tags"> <div class="vector-toc-text"> 5 Tags </div> </a> <ul id="toc-Tags-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Examples" class="vector-toc-list-item vector-toc-level-1"> <a class="vector-toc-link" href="#Examples"> <div class="vector-toc-text"> 6 Examples </div> </a> <button aria-controls="toc-Examples-sublist" class="cdx-button cdx-button--weight-quiet cdx-button--icon-only vector-toc-toggle"> Toggle Examples subsection </button> <ul id="toc-Examples-sublist" class="vector-toc-list"> <li id="toc-Comparison" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Comparison"> <div class="vector-toc-text"> 6.1 Comparison </div> </a> <ul id="toc-Comparison-sublist" class="vector-toc-list"> <li id="toc-Ada" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Ada"> <div class="vector-toc-text"> 6.1.1 Ada </div> </a> <ul id="toc-Ada-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-APL" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#APL"> <div class="vector-toc-text"> 6.1.2 APL </div> </a> <ul id="toc-APL-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-AppleScript" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#AppleScript"> <div class="vector-toc-text"> 6.1.3 AppleScript </div> </a> <ul id="toc-AppleScript-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-BASIC" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#BASIC"> <div class="vector-toc-text"> 6.1.4 BASIC </div> </a> <ul id="toc-BASIC-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-C" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#C"> <div class="vector-toc-text"> 6.1.5 C </div> </a> <ul id="toc-C-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Cisco_IOS_and_IOS-XE_configuration" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Cisco_IOS_and_IOS-XE_configuration"> <div class="vector-toc-text"> 6.1.6 Cisco IOS and IOS-XE configuration </div> </a> <ul id="toc-Cisco_IOS_and_IOS-XE_configuration-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-ColdFusion" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#ColdFusion"> <div class="vector-toc-text"> 6.1.7 ColdFusion </div> </a> <ul id="toc-ColdFusion-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-D" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#D"> <div class="vector-toc-text"> 6.1.8 D </div> </a> <ul id="toc-D-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Fortran_IV" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Fortran_IV"> <div class="vector-toc-text"> 6.1.9 Fortran IV </div> </a> <ul id="toc-Fortran_IV-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Fortran_90" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Fortran_90"> <div class="vector-toc-text"> 6.1.10 Fortran 90 </div> </a> <ul id="toc-Fortran_90-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Haskell" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Haskell"> <div class="vector-toc-text"> 6.1.11 Haskell </div> </a> <ul id="toc-Haskell-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Java" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Java"> <div class="vector-toc-text"> 6.1.12 Java </div> </a> <ul id="toc-Java-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-JavaScript" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#JavaScript"> <div class="vector-toc-text"> 6.1.13 JavaScript </div> </a> <ul id="toc-JavaScript-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Lua" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Lua"> <div class="vector-toc-text"> 6.1.14 Lua </div> </a> <ul id="toc-Lua-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-MATLAB" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#MATLAB"> <div class="vector-toc-text"> 6.1.15 MATLAB </div> </a> <ul id="toc-MATLAB-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Nim" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Nim"> <div class="vector-toc-text"> 6.1.16 Nim </div> </a> <ul id="toc-Nim-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-OCaml" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#OCaml"> <div class="vector-toc-text"> 6.1.17 OCaml </div> </a> <ul id="toc-OCaml-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Pascal,_Delphi" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Pascal,_Delphi"> <div class="vector-toc-text"> 6.1.18 Pascal, Delphi </div> </a> <ul id="toc-Pascal,_Delphi-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Perl" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Perl"> <div class="vector-toc-text"> 6.1.19 Perl </div> </a> <ul id="toc-Perl-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-R" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#R"> <div class="vector-toc-text"> 6.1.20 R </div> </a> <ul id="toc-R-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Raku" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Raku"> <div class="vector-toc-text"> 6.1.21 Raku </div> </a> <ul id="toc-Raku-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-PHP" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#PHP"> <div class="vector-toc-text"> 6.1.22 PHP </div> </a> <ul id="toc-PHP-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-PowerShell" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#PowerShell"> <div class="vector-toc-text"> 6.1.23 PowerShell </div> </a> <ul id="toc-PowerShell-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Python" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Python"> <div class="vector-toc-text"> 6.1.24 Python </div> </a> <ul id="toc-Python-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Ruby" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Ruby"> <div class="vector-toc-text"> 6.1.25 Ruby </div> </a> <ul id="toc-Ruby-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-SQL" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#SQL"> <div class="vector-toc-text"> 6.1.26 SQL </div> </a> <ul id="toc-SQL-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Swift" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Swift"> <div class="vector-toc-text"> 6.1.27 Swift </div> </a> <ul id="toc-Swift-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-XML_(or_HTML)" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#XML_(or_HTML)"> <div class="vector-toc-text"> 6.1.28 XML (or HTML) </div> </a> <ul id="toc-XML_(or_HTML)-sublist" class="vector-toc-list"> </ul> </li> </ul> </li> </ul> </li> <li id="toc-Security_issues" class="vector-toc-list-item vector-toc-level-1"> <a class="vector-toc-link" href="#Security_issues"> <div class="vector-toc-text"> 7 Security issues </div> </a> <ul id="toc-Security_issues-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-See_also" class="vector-toc-list-item vector-toc-level-1"> <a class="vector-toc-link" href="#See_also"> <div class="vector-toc-text"> 8 See also </div> </a> <ul id="toc-See_also-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Notes_and_references" class="vector-toc-list-item vector-toc-level-1"> <a class="vector-toc-link" href="#Notes_and_references"> <div class="vector-toc-text"> 9 Notes and references </div> </a> <ul id="toc-Notes_and_references-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Further_reading" class="vector-toc-list-item vector-toc-level-1"> <a class="vector-toc-link" href="#Further_reading"> <div class="vector-toc-text"> 10 Further reading </div> </a> <ul id="toc-Further_reading-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-External_links" class="vector-toc-list-item vector-toc-level-1"> <a class="vector-toc-link" href="#External_links"> <div class="vector-toc-text"> 11 External links </div> </a> <ul id="toc-External_links-sublist" class="vector-toc-list"> </ul> </li> </ul> </div> </div> </nav> </div> </div> <div class="mw-content-container"> <main id="content" class="mw-body"> <header class="mw-body-header vector-page-titlebar"> <nav aria-label="Contents" class="vector-toc-landmark"> <div id="vector-page-titlebar-toc" class="vector-dropdown vector-page-titlebar-toc vector-button-flush-left" > <input type="checkbox" id="vector-page-titlebar-toc-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-page-titlebar-toc" class="vector-dropdown-checkbox " aria-label="Toggle the table of contents" > <label id="vector-page-titlebar-toc-label" for="vector-page-titlebar-toc-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" > Toggle the table of contents </label> <div class="vector-dropdown-content"> <div id="vector-page-titlebar-toc-unpinned-container" class="vector-unpinned-container"> </div> </div> </div> </nav> <h1 id="firstHeading" class="firstHeading mw-first-heading">Comment (computer programming)</h1> <div id="p-lang-btn" class="vector-dropdown mw-portlet mw-portlet-lang" > <input type="checkbox" id="p-lang-btn-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-p-lang-btn" class="vector-dropdown-checkbox mw-interlanguage-selector" aria-label="Go to an article in another language. Available in 28 languages" > <label id="p-lang-btn-label" for="p-lang-btn-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--action-progressive mw-portlet-lang-heading-28" aria-hidden="true" > 28 languages </label> <div class="vector-dropdown-content"> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li class="interlanguage-link interwiki-ar mw-list-item"><a href="https://ar.wikipedia.org/wiki/%D8%AA%D8%B9%D9%84%D9%8A%D9%82_(%D8%A8%D8%B1%D9%85%D8%AC%D8%A9)" title="تعليق (برمجة) – Arabic" lang="ar" hreflang="ar" data-title="تعليق (برمجة)" data-language-autonym="العربية" data-language-local-name="Arabic" class="interlanguage-link-target">العربية</a></li><li class="interlanguage-link interwiki-az mw-list-item"><a href="https://az.wikipedia.org/wiki/%C5%9E%C9%99rh_(proqramla%C5%9Fd%C4%B1rma)" title="Şərh (proqramlaşdırma) – Azerbaijani" lang="az" hreflang="az" data-title="Şərh (proqramlaşdırma)" data-language-autonym="Azərbaycanca" data-language-local-name="Azerbaijani" class="interlanguage-link-target">Azərbaycanca</a></li><li class="interlanguage-link interwiki-cs mw-list-item"><a href="https://cs.wikipedia.org/wiki/Koment%C3%A1%C5%99_(programov%C3%A1n%C3%AD)" title="Komentář (programování) – Czech" lang="cs" hreflang="cs" data-title="Komentář (programování)" data-language-autonym="Čeština" data-language-local-name="Czech" class="interlanguage-link-target">Čeština</a></li><li class="interlanguage-link interwiki-da mw-list-item"><a href="https://da.wikipedia.org/wiki/Kommentar_(datalogi)" title="Kommentar (datalogi) – Danish" lang="da" hreflang="da" data-title="Kommentar (datalogi)" data-language-autonym="Dansk" data-language-local-name="Danish" class="interlanguage-link-target">Dansk</a></li><li class="interlanguage-link interwiki-de mw-list-item"><a href="https://de.wikipedia.org/wiki/Kommentar_(Programmierung)" title="Kommentar (Programmierung) – German" lang="de" hreflang="de" data-title="Kommentar (Programmierung)" data-language-autonym="Deutsch" data-language-local-name="German" class="interlanguage-link-target">Deutsch</a></li><li class="interlanguage-link interwiki-et mw-list-item"><a href="https://et.wikipedia.org/wiki/Kommentaar_(programmeerimine)" title="Kommentaar (programmeerimine) – Estonian" lang="et" hreflang="et" data-title="Kommentaar (programmeerimine)" data-language-autonym="Eesti" data-language-local-name="Estonian" class="interlanguage-link-target">Eesti</a></li><li class="interlanguage-link interwiki-el mw-list-item"><a href="https://el.wikipedia.org/wiki/%CE%A3%CF%87%CF%8C%CE%BB%CE%B9%CE%BF_(%CF%80%CF%81%CE%BF%CE%B3%CF%81%CE%B1%CE%BC%CE%BC%CE%B1%CF%84%CE%B9%CF%83%CE%BC%CF%8C%CF%82)" title="Σχόλιο (προγραμματισμός) – Greek" lang="el" hreflang="el" data-title="Σχόλιο (προγραμματισμός)" data-language-autonym="Ελληνικά" data-language-local-name="Greek" class="interlanguage-link-target">Ελληνικά</a></li><li class="interlanguage-link interwiki-es mw-list-item"><a href="https://es.wikipedia.org/wiki/Comentario_(inform%C3%A1tica)" title="Comentario (informática) – Spanish" lang="es" hreflang="es" data-title="Comentario (informática)" data-language-autonym="Español" data-language-local-name="Spanish" class="interlanguage-link-target">Español</a></li><li class="interlanguage-link interwiki-eo mw-list-item"><a href="https://eo.wikipedia.org/wiki/Kodkomento" title="Kodkomento – Esperanto" lang="eo" hreflang="eo" data-title="Kodkomento" data-language-autonym="Esperanto" data-language-local-name="Esperanto" class="interlanguage-link-target">Esperanto</a></li><li class="interlanguage-link interwiki-eu mw-list-item"><a href="https://eu.wikipedia.org/wiki/Ohar_(programazioa)" title="Ohar (programazioa) – Basque" lang="eu" hreflang="eu" data-title="Ohar (programazioa)" data-language-autonym="Euskara" data-language-local-name="Basque" class="interlanguage-link-target">Euskara</a></li><li class="interlanguage-link interwiki-fa mw-list-item"><a href="https://fa.wikipedia.org/wiki/%D8%AA%D9%88%D8%B6%DB%8C%D8%AD_(%D8%A8%D8%B1%D9%86%D8%A7%D9%85%D9%87%E2%80%8C%D9%86%D9%88%DB%8C%D8%B3%DB%8C_%D8%B1%D8%A7%DB%8C%D8%A7%D9%86%D9%87%E2%80%8C%D8%A7%DB%8C)" title="توضیح (برنامه‌نویسی رایانه‌ای) – Persian" lang="fa" hreflang="fa" data-title="توضیح (برنامه‌نویسی رایانه‌ای)" data-language-autonym="فارسی" data-language-local-name="Persian" class="interlanguage-link-target">فارسی</a></li><li class="interlanguage-link interwiki-fr mw-list-item"><a href="https://fr.wikipedia.org/wiki/Commentaire_(informatique)" title="Commentaire (informatique) – French" lang="fr" hreflang="fr" data-title="Commentaire (informatique)" data-language-autonym="Français" data-language-local-name="French" class="interlanguage-link-target">Français</a></li><li class="interlanguage-link interwiki-ko mw-list-item"><a href="https://ko.wikipedia.org/wiki/%EC%A3%BC%EC%84%9D_(%ED%94%84%EB%A1%9C%EA%B7%B8%EB%9E%98%EB%B0%8D)" title="주석 (프로그래밍) – Korean" lang="ko" hreflang="ko" data-title="주석 (프로그래밍)" data-language-autonym="한국어" data-language-local-name="Korean" class="interlanguage-link-target">한국어</a></li><li class="interlanguage-link interwiki-it mw-list-item"><a href="https://it.wikipedia.org/wiki/Commento_(informatica)" title="Commento (informatica) – Italian" lang="it" hreflang="it" data-title="Commento (informatica)" data-language-autonym="Italiano" data-language-local-name="Italian" class="interlanguage-link-target">Italiano</a></li><li class="interlanguage-link interwiki-kk mw-list-item"><a href="https://kk.wikipedia.org/wiki/%D0%A2%D2%AF%D1%81%D1%96%D0%BD%D1%96%D0%BA%D1%82%D0%B5%D0%BC%D0%B5_(%D0%B1%D0%B0%D2%93%D0%B4%D0%B0%D1%80%D0%BB%D0%B0%D0%BC%D0%B0%D0%BB%D0%B0%D1%83)" title="Түсініктеме (бағдарламалау) – Kazakh" lang="kk" hreflang="kk" data-title="Түсініктеме (бағдарламалау)" data-language-autonym="Қазақша" data-language-local-name="Kazakh" class="interlanguage-link-target">Қазақша</a></li><li class="interlanguage-link interwiki-nl mw-list-item"><a href="https://nl.wikipedia.org/wiki/Commentaar_(programmeren)" title="Commentaar (programmeren) – Dutch" lang="nl" hreflang="nl" data-title="Commentaar (programmeren)" data-language-autonym="Nederlands" data-language-local-name="Dutch" class="interlanguage-link-target">Nederlands</a></li><li class="interlanguage-link interwiki-ja mw-list-item"><a href="https://ja.wikipedia.org/wiki/%E3%82%B3%E3%83%A1%E3%83%B3%E3%83%88_(%E3%82%B3%E3%83%B3%E3%83%94%E3%83%A5%E3%83%BC%E3%82%BF)" title="コメント (コンピュータ) – Japanese" lang="ja" hreflang="ja" data-title="コメント (コンピュータ)" data-language-autonym="日本語" data-language-local-name="Japanese" class="interlanguage-link-target">日本語</a></li><li class="interlanguage-link interwiki-mhr mw-list-item"><a href="https://mhr.wikipedia.org/wiki/%D0%9E%D0%B9%D0%BF%D0%B5%D0%BB%D0%B5%D1%88%D1%82%D1%8B%D1%88" title="Ойпелештыш – Eastern Mari" lang="mhr" hreflang="mhr" data-title="Ойпелештыш" data-language-autonym="Олык марий" data-language-local-name="Eastern Mari" class="interlanguage-link-target">Олык марий</a></li><li class="interlanguage-link interwiki-pl mw-list-item"><a href="https://pl.wikipedia.org/wiki/Komentarz_(informatyka)" title="Komentarz (informatyka) – Polish" lang="pl" hreflang="pl" data-title="Komentarz (informatyka)" data-language-autonym="Polski" data-language-local-name="Polish" class="interlanguage-link-target">Polski</a></li><li class="interlanguage-link interwiki-ru mw-list-item"><a href="https://ru.wikipedia.org/wiki/%D0%9A%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B8_(%D0%BF%D1%80%D0%BE%D0%B3%D1%80%D0%B0%D0%BC%D0%BC%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5)" title="Комментарии (программирование) – Russian" lang="ru" hreflang="ru" data-title="Комментарии (программирование)" data-language-autonym="Русский" data-language-local-name="Russian" class="interlanguage-link-target">Русский</a></li><li class="interlanguage-link interwiki-ckb mw-list-item"><a href="https://ckb.wikipedia.org/wiki/%D9%84%DB%8E%D8%AF%D9%88%D8%A7%D9%86_(%D8%A8%DB%95%D8%B1%D9%86%D8%A7%D9%85%DB%95%D8%B3%D8%A7%D8%B2%DB%8C)" title="لێدوان (بەرنامەسازی) – Central Kurdish" lang="ckb" hreflang="ckb" data-title="لێدوان (بەرنامەسازی)" data-language-autonym="کوردی" data-language-local-name="Central Kurdish" class="interlanguage-link-target">کوردی</a></li><li class="interlanguage-link interwiki-sv mw-list-item"><a href="https://sv.wikipedia.org/wiki/Kodkommentar" title="Kodkommentar – Swedish" lang="sv" hreflang="sv" data-title="Kodkommentar" data-language-autonym="Svenska" data-language-local-name="Swedish" class="interlanguage-link-target">Svenska</a></li><li class="interlanguage-link interwiki-ta mw-list-item"><a href="https://ta.wikipedia.org/wiki/%E0%AE%95%E0%AF%81%E0%AE%B1%E0%AE%BF%E0%AE%AA%E0%AF%8D%E0%AE%AA%E0%AF%81%E0%AE%B0%E0%AF%88_(%E0%AE%A8%E0%AE%BF%E0%AE%B0%E0%AE%B2%E0%AE%BE%E0%AE%95%E0%AF%8D%E0%AE%95%E0%AE%AE%E0%AF%8D)" title="குறிப்புரை (நிரலாக்கம்) – Tamil" lang="ta" hreflang="ta" data-title="குறிப்புரை (நிரலாக்கம்)" data-language-autonym="தமிழ்" data-language-local-name="Tamil" class="interlanguage-link-target">தமிழ்</a></li><li class="interlanguage-link interwiki-tr mw-list-item"><a href="https://tr.wikipedia.org/wiki/Yorum_sat%C4%B1r%C4%B1" title="Yorum satırı – Turkish" lang="tr" hreflang="tr" data-title="Yorum satırı" data-language-autonym="Türkçe" data-language-local-name="Turkish" class="interlanguage-link-target">Türkçe</a></li><li class="interlanguage-link interwiki-uk mw-list-item"><a href="https://uk.wikipedia.org/wiki/%D0%9A%D0%BE%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80_(%D0%BF%D1%80%D0%BE%D0%B3%D1%80%D0%B0%D0%BC%D1%83%D0%B2%D0%B0%D0%BD%D0%BD%D1%8F)" title="Коментар (програмування) – Ukrainian" lang="uk" hreflang="uk" data-title="Коментар (програмування)" data-language-autonym="Українська" data-language-local-name="Ukrainian" class="interlanguage-link-target">Українська</a></li><li class="interlanguage-link interwiki-vi mw-list-item"><a href="https://vi.wikipedia.org/wiki/Comment_(l%E1%BA%ADp_tr%C3%ACnh_m%C3%A1y_t%C3%ADnh)" title="Comment (lập trình máy tính) – Vietnamese" lang="vi" hreflang="vi" data-title="Comment (lập trình máy tính)" data-language-autonym="Tiếng Việt" data-language-local-name="Vietnamese" class="interlanguage-link-target">Tiếng Việt</a></li><li class="interlanguage-link interwiki-zh-yue mw-list-item"><a href="https://zh-yue.wikipedia.org/wiki/%E7%A8%8B%E5%BC%8F%E6%B3%A8%E9%87%8B" title="程式注釋 – Cantonese" lang="yue" hreflang="yue" data-title="程式注釋" data-language-autonym="粵語" data-language-local-name="Cantonese" class="interlanguage-link-target">粵語</a></li><li class="interlanguage-link interwiki-zh mw-list-item"><a href="https://zh.wikipedia.org/wiki/%E8%A8%BB%E8%A7%A3_(%E7%A8%8B%E5%BC%8F%E8%A8%AD%E8%A8%88)" title="註解 (程式設計) – Chinese" lang="zh" hreflang="zh" data-title="註解 (程式設計)" data-language-autonym="中文" data-language-local-name="Chinese" class="interlanguage-link-target">中文</a></li> </ul> <div class="after-portlet after-portlet-lang"><a href="https://www.wikidata.org/wiki/Special:EntityPage/Q1141067#sitelinks-wikipedia" title="Edit interlanguage links" class="wbc-editpage">Edit links</a></div> </div> </div> </div> </header> <div class="vector-page-toolbar"> <div class="vector-page-toolbar-container"> <div id="left-navigation"> <nav aria-label="Namespaces"> <div id="p-associated-pages" class="vector-menu vector-menu-tabs mw-portlet mw-portlet-associated-pages" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="ca-nstab-main" class="selected vector-tab-noicon mw-list-item"><a href="/wiki/Comment_(computer_programming)" title="View the content page [c]" accesskey="c">Article</a></li><li id="ca-talk" class="vector-tab-noicon mw-list-item"><a href="/wiki/Talk:Comment_(computer_programming)" rel="discussion" title="Discuss improvements to the content page [t]" accesskey="t">Talk</a></li> </ul> </div> </div> <div id="vector-variants-dropdown" class="vector-dropdown emptyPortlet" > <input type="checkbox" id="vector-variants-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-variants-dropdown" class="vector-dropdown-checkbox " aria-label="Change language variant" > <label id="vector-variants-dropdown-label" for="vector-variants-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet" aria-hidden="true" >English </label> <div class="vector-dropdown-content"> <div id="p-variants" class="vector-menu mw-portlet mw-portlet-variants emptyPortlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> </div> </div> </nav> </div> <div id="right-navigation" class="vector-collapsible"> <nav aria-label="Views"> <div id="p-views" class="vector-menu vector-menu-tabs mw-portlet mw-portlet-views" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="ca-view" class="selected vector-tab-noicon mw-list-item"><a href="/wiki/Comment_(computer_programming)">Read</a></li><li id="ca-edit" class="vector-tab-noicon mw-list-item"><a href="/w/index.php?title=Comment_(computer_programming)&action=edit" title="Edit this page [e]" accesskey="e">Edit</a></li><li id="ca-history" class="vector-tab-noicon mw-list-item"><a href="/w/index.php?title=Comment_(computer_programming)&action=history" title="Past revisions of this page [h]" accesskey="h">View history</a></li> </ul> </div> </div> </nav> <nav class="vector-page-tools-landmark" aria-label="Page tools"> <div id="vector-page-tools-dropdown" class="vector-dropdown vector-page-tools-dropdown" > <input type="checkbox" id="vector-page-tools-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-page-tools-dropdown" class="vector-dropdown-checkbox " aria-label="Tools" > <label id="vector-page-tools-dropdown-label" for="vector-page-tools-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet" aria-hidden="true" >Tools </label> <div class="vector-dropdown-content"> <div id="vector-page-tools-unpinned-container" class="vector-unpinned-container"> <div id="vector-page-tools" class="vector-page-tools vector-pinnable-element"> <div class="vector-pinnable-header vector-page-tools-pinnable-header vector-pinnable-header-unpinned" data-feature-name="page-tools-pinned" data-pinnable-element-id="vector-page-tools" data-pinned-container-id="vector-page-tools-pinned-container" data-unpinned-container-id="vector-page-tools-unpinned-container" > <div class="vector-pinnable-header-label">Tools</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-page-tools.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-page-tools.unpin">hide</button> </div> <div id="p-cactions" class="vector-menu mw-portlet mw-portlet-cactions emptyPortlet vector-has-collapsible-items" title="More options" > <div class="vector-menu-heading"> Actions </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="ca-more-view" class="selected vector-more-collapsible-item mw-list-item"><a href="/wiki/Comment_(computer_programming)">Read</a></li><li id="ca-more-edit" class="vector-more-collapsible-item mw-list-item"><a href="/w/index.php?title=Comment_(computer_programming)&action=edit" title="Edit this page [e]" accesskey="e">Edit</a></li><li id="ca-more-history" class="vector-more-collapsible-item mw-list-item"><a href="/w/index.php?title=Comment_(computer_programming)&action=history">View history</a></li> </ul> </div> </div> <div id="p-tb" class="vector-menu mw-portlet mw-portlet-tb" > <div class="vector-menu-heading"> General </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="t-whatlinkshere" class="mw-list-item"><a href="/wiki/Special:WhatLinksHere/Comment_(computer_programming)" title="List of all English Wikipedia pages containing links to this page [j]" accesskey="j">What links here</a></li><li id="t-recentchangeslinked" class="mw-list-item"><a href="/wiki/Special:RecentChangesLinked/Comment_(computer_programming)" rel="nofollow" title="Recent changes in pages linked from this page [k]" accesskey="k">Related changes</a></li><li id="t-upload" class="mw-list-item"><a href="/wiki/Wikipedia:File_Upload_Wizard" title="Upload files [u]" accesskey="u">Upload file</a></li><li id="t-specialpages" class="mw-list-item"><a href="/wiki/Special:SpecialPages" title="A list of all special pages [q]" accesskey="q">Special pages</a></li><li id="t-permalink" class="mw-list-item"><a href="/w/index.php?title=Comment_(computer_programming)&oldid=1258397066" title="Permanent link to this revision of this page">Permanent link</a></li><li id="t-info" class="mw-list-item"><a href="/w/index.php?title=Comment_(computer_programming)&action=info" title="More information about this page">Page information</a></li><li id="t-cite" class="mw-list-item"><a href="/w/index.php?title=Special:CiteThisPage&page=Comment_%28computer_programming%29&id=1258397066&wpFormIdentifier=titleform" title="Information on how to cite this page">Cite this page</a></li><li id="t-urlshortener" class="mw-list-item"><a href="/w/index.php?title=Special:UrlShortener&url=https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FComment_%28computer_programming%29">Get shortened URL</a></li><li id="t-urlshortener-qrcode" class="mw-list-item"><a href="/w/index.php?title=Special:QrCode&url=https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FComment_%28computer_programming%29">Download QR code</a></li> </ul> </div> </div> <div id="p-coll-print_export" class="vector-menu mw-portlet mw-portlet-coll-print_export" > <div class="vector-menu-heading"> Print/export </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="coll-download-as-rl" class="mw-list-item"><a href="/w/index.php?title=Special:DownloadAsPdf&page=Comment_%28computer_programming%29&action=show-download-screen" title="Download this page as a PDF file">Download as PDF</a></li><li id="t-print" class="mw-list-item"><a href="/w/index.php?title=Comment_(computer_programming)&printable=yes" title="Printable version of this page [p]" accesskey="p">Printable version</a></li> </ul> </div> </div> <div id="p-wikibase-otherprojects" class="vector-menu mw-portlet mw-portlet-wikibase-otherprojects" > <div class="vector-menu-heading"> In other projects </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="t-wikibase" class="wb-otherproject-link wb-otherproject-wikibase-dataitem mw-list-item"><a href="https://www.wikidata.org/wiki/Special:EntityPage/Q1141067" title="Structured data on this page hosted by Wikidata [g]" accesskey="g">Wikidata item</a></li> </ul> </div> </div> </div> </div> </div> </div> </nav> </div> </div> </div> <div class="vector-column-end"> <div class="vector-sticky-pinned-container"> <nav class="vector-page-tools-landmark" aria-label="Page tools"> <div id="vector-page-tools-pinned-container" class="vector-pinned-container"> </div> </nav> <nav class="vector-appearance-landmark" aria-label="Appearance"> <div id="vector-appearance-pinned-container" class="vector-pinned-container"> <div id="vector-appearance" class="vector-appearance vector-pinnable-element"> <div class="vector-pinnable-header vector-appearance-pinnable-header vector-pinnable-header-pinned" data-feature-name="appearance-pinned" data-pinnable-element-id="vector-appearance" data-pinned-container-id="vector-appearance-pinned-container" data-unpinned-container-id="vector-appearance-unpinned-container" > <div class="vector-pinnable-header-label">Appearance</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-appearance.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-appearance.unpin">hide</button> </div> </div> </div> </nav> </div> </div> <div id="bodyContent" class="vector-body" aria-labelledby="firstHeading" data-mw-ve-target-container> <div class="vector-body-before-content"> <div class="mw-indicators"> </div> <div id="siteSub" class="noprint">From Wikipedia, the free encyclopedia</div> </div> <div id="contentSub"><div id="mw-content-subtitle">(Redirected from <a href="/w/index.php?title=REM_(DOS_command)&redirect=no" class="mw-redirect" title="REM (DOS command)">REM (DOS command)</a>)</div></div> <div id="mw-content-text" class="mw-body-content"><div class="mw-content-ltr mw-parser-output" lang="en" dir="ltr"><div class="shortdescription nomobile noexcerpt noprint searchaux" style="display:none">Explanatory note in the source code of a computer program</div> <style data-mw-deduplicate="TemplateStyles:r1236090951">.mw-parser-output .hatnote{font-style:italic}.mw-parser-output div.hatnote{padding-left:1.6em;margin-bottom:0.5em}.mw-parser-output .hatnote i{font-style:normal}.mw-parser-output .hatnote+link+.hatnote{margin-top:-0.5em}@media print{body.ns-0 .mw-parser-output .hatnote{display:none!important}}</style><div role="note" class="hatnote navigation-not-searchable selfref">For comments in Wikipedia markup, see <a href="/wiki/Help:Wiki_markup#Character_formatting" class="mw-redirect" title="Help:Wiki markup">Help:Wiki markup § Character formatting</a>, and <a href="/wiki/Wikipedia:COMMENT" class="mw-redirect" title="Wikipedia:COMMENT">WP:COMMENT</a>.</div> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1236090951"><div role="note" class="hatnote navigation-not-searchable selfref">"/*" and "*/" redirect here. For their use in Wikipedia edit summaries, see <a href="/wiki/Help:Edit_summary#Section_editing" title="Help:Edit summary">Help:Edit summary § Section editing</a>.</div> <figure class="mw-halign-right" typeof="mw:File/Thumb"><a href="/wiki/File:CodeCmmt002.svg" class="mw-file-description"><img src="//upload.wikimedia.org/wikipedia/commons/thumb/7/75/CodeCmmt002.svg/300px-CodeCmmt002.svg.png" decoding="async" width="300" height="269" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/commons/thumb/7/75/CodeCmmt002.svg/450px-CodeCmmt002.svg.png 1.5x, //upload.wikimedia.org/wikipedia/commons/thumb/7/75/CodeCmmt002.svg/600px-CodeCmmt002.svg.png 2x" data-file-width="356" data-file-height="319" /></a><figcaption>An illustration of <a href="/wiki/Java_(programming_language)" title="Java (programming language)">Java</a> source code with prologue comments indicated in red and inline comments in green. Program code is in blue.</figcaption></figure> In <a href="/wiki/Computer_programming" title="Computer programming">computer programming</a>, a comment is a <a href="/wiki/Human-readable" class="mw-redirect" title="Human-readable">human-readable</a> explanation or <a href="/wiki/Annotation" title="Annotation">annotation</a> in the <a href="/wiki/Source_code" title="Source code">source code</a> of a <a href="/wiki/Computer_program" title="Computer program">computer program</a>. They are added with the purpose of making the source code easier for humans to understand, and are generally ignored by <a href="/wiki/Compiler" title="Compiler">compilers</a> and <a href="/wiki/Interpreter_(computing)" title="Interpreter (computing)">interpreters</a>.<a href="#cite_note-PennyGrubb000-1">[1]</a><a href="#cite_note-2">[2]</a> The <a href="/wiki/Comparison_of_programming_languages_(syntax)#Comments" title="Comparison of programming languages (syntax)">syntax of comments</a> in various programming languages varies considerably. Comments are sometimes also processed in various ways to generate documentation external to the source code itself by <a href="/wiki/Documentation_generator" title="Documentation generator">documentation generators</a>, or used for integration with <a href="/wiki/Version_control" title="Version control">source code management</a> systems and other kinds of external <a href="/wiki/Programming_tool" title="Programming tool">programming tools</a>. The flexibility provided by comments allows for a wide degree of variability, but formal conventions for their use are commonly part of <a href="/wiki/Programming_style" title="Programming style">programming style</a> guides. <meta property="mw:PageProp/toc" /> <div class="mw-heading mw-heading2"><h2 id="Overview">Overview</h2>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=1" title="Edit section: Overview">edit</a>]</div> Comments are generally formatted as either block comments (also called prologue comments or stream comments) or line comments (also called inline comments).<a href="#cite_note-JBDixit000-3">[3]</a> Block comments <a href="/wiki/Delimiter#Bracket_delimiters" title="Delimiter">delimit</a> a region of source code which may span multiple lines or a part of a single line. This region is specified with a start delimiter and an end delimiter. Some programming languages (such as <a href="/wiki/MATLAB" title="MATLAB">MATLAB</a>) allow block comments to be recursively nested inside one another, but others (such as <a href="/wiki/Java_(programming_language)" title="Java (programming language)">Java</a>) do not.<a href="#cite_note-Higham000-4">[4]</a><a href="#cite_note-Vermeulen000-5">[5]</a><a href="#cite_note-javadude000-6">[6]</a> Line comments either start with a comment delimiter and continue until the end of the line, or in some cases, start at a specific column (character line offset) in the source code, and continue until the end of the line.<a href="#cite_note-javadude000-6">[6]</a> Some programming languages employ both block and line comments with different comment delimiters. For example, <a href="/wiki/C%2B%2B" title="C++">C++</a> has block comments delimited by <code>/*</code> and <code>*/</code> that can span multiple lines and line comments delimited by <code>//</code>. Other languages support only one type of comment. For example, <a href="/wiki/Ada_(programming_language)" title="Ada (programming language)">Ada</a> comments are line comments: they start with <code>--</code> and continue to the end of the line.<a href="#cite_note-javadude000-6">[6]</a> <div class="mw-heading mw-heading2"><h2 id="Uses">Uses</h2>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=2" title="Edit section: Uses">edit</a>]</div> How best to make use of comments is subject to dispute; different commentators have offered varied and sometimes opposing viewpoints.<a href="#cite_note-Dietrich000-7">[7]</a><a href="#cite_note-Keyes000-8">[8]</a> There are many different ways of writing comments and many commentators offer conflicting advice.<a href="#cite_note-Keyes000-8">[8]</a> <div class="mw-heading mw-heading3"><h3 id="Planning_and_reviewing">Planning and reviewing</h3>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=3" title="Edit section: Planning and reviewing">edit</a>]</div> Comments can be used as a form of <a href="/wiki/Pseudocode" title="Pseudocode">pseudocode</a> to outline intention prior to writing the actual code. In this case it should explain the logic behind the code rather than the code itself. <div class="mw-highlight mw-highlight-lang-cpp mw-content-ltr" dir="ltr"><pre>/* loop backwards through all elements returned by the server (they should be processed chronologically)*/ for (i = (numElementsReturned - 0); i >= 1; i--) { /* process each element's data */ updatePattern(i, returnedElements[i]); } </pre></div> If this type of comment is left in, it simplifies the review process by allowing a direct comparison of the code with the intended results. A common logical fallacy is that code that is easy to understand does what it's supposed to do. <div class="mw-heading mw-heading3"><h3 id="Code_description">Code description</h3>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=4" title="Edit section: Code description">edit</a>]</div> Comments can be used to summarize code or to explain the programmer's intent. According to this school of thought, restating the code in plain English is considered superfluous; the need to re-explain code may be a sign that it is too complex and should be rewritten, or that the naming is bad. <dl><dd>"Don't document bad code – rewrite it."<a href="#cite_note-BadComment000-9">[9]</a></dd></dl> <dl><dd>"Good comments don't repeat the code or explain it. They clarify its intent. Comments should explain, at a higher level of abstraction than the code, what you're trying to do."<a href="#cite_note-GoodComment000-10">[10]</a></dd></dl> Comments may also be used to explain why a block of code does not seem to fit conventions or best practices. This is especially true of projects involving very little development time, or in bug fixing. For example: <div class="mw-highlight mw-highlight-lang-vbscript mw-content-ltr" dir="ltr"><pre>' Second variable dim because of server errors produced when reuse form data. No ' documentation available on server behavior issue, so just coding around it. vtx = server.mappath("local settings") </pre></div> <div class="mw-heading mw-heading3"><h3 id="Algorithmic_description">Algorithmic description</h3>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=5" title="Edit section: Algorithmic description">edit</a>]</div> Sometimes source code contains a novel or noteworthy solution to a specific problem. In such cases, comments may contain an explanation of the methodology. Such explanations may include diagrams and formal mathematical proofs. This may constitute explanation of the code, rather than a clarification of its intent; but others tasked with maintaining the code base may find such explanation crucial. This might especially be true in the case of highly specialized problem domains; or rarely used optimizations, constructs or function-calls.<a href="#cite_note-AlgoComments-11">[11]</a> For example, a programmer may add a comment to explain why an <a href="/wiki/Insertion_sort" title="Insertion sort">insertion sort</a> was chosen instead of a <a href="/wiki/Quicksort" title="Quicksort">quicksort</a>, as the former is, in theory, slower than the latter. This could be written as follows: <div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre> list = [f (b), f (b), f (c), f (d), f (a), ...]; // Need a stable sort. Besides, the performance really does not matter. insertion_sort (list); </pre></div> <div class="mw-heading mw-heading3"><h3 id="Resource_inclusion">Resource inclusion</h3>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=6" title="Edit section: Resource inclusion">edit</a>]</div> <a href="/wiki/Logo" title="Logo">Logos</a>, diagrams, and <a href="/wiki/Flowchart" title="Flowchart">flowcharts</a> consisting of <a href="/wiki/ASCII_art" title="ASCII art">ASCII art</a> constructions can be inserted into source code formatted as a comment.<a href="#cite_note-asciiart000-12">[12]</a> Further, <a href="/wiki/Copyright" title="Copyright">copyright</a> notices can be embedded within source code as comments. Binary data may also be encoded in comments through a process known as <a href="/wiki/Binary-to-text_encoding" title="Binary-to-text encoding">binary-to-text encoding</a>, although such practice is uncommon and typically relegated to external resource files. The following code fragment is a simple ASCII diagram depicting the process flow for a <a href="/wiki/System_administration" class="mw-redirect" title="System administration">system administration</a> script contained in a <a href="/wiki/Windows_Script_File" title="Windows Script File">Windows Script File</a> running under <a href="/wiki/Windows_Script_Host" title="Windows Script Host">Windows Script Host</a>. Although a section marking the code appears as a comment, the diagram itself actually appears in an <a href="/wiki/XML" title="XML">XML</a> <a href="/wiki/CDATA" title="CDATA">CDATA</a> section, which is technically considered distinct from comments, but can serve similar purposes.<a href="#cite_note-Niederst000-13">[13]</a> <div class="mw-highlight mw-highlight-lang-xml mw-content-ltr" dir="ltr"><pre> <resource id="ProcessDiagram000"> <![CDATA[ HostApp (Main_process) | V script.wsf (app_cmd) --> ClientApp (async_run, batch_process) | | V mru.ini (mru_history) ]]> </resource> </pre></div> Although this identical diagram could easily have been included as a comment, the example illustrates one instance where a programmer may opt not to use comments as a way of including resources in source code.<a href="#cite_note-Niederst000-13">[13]</a> <div class="mw-heading mw-heading3"><h3 id="Metadata">Metadata</h3>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=7" title="Edit section: Metadata">edit</a>]</div> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1236090951"><div role="note" class="hatnote navigation-not-searchable">Main article: <a href="/wiki/Metadata" title="Metadata">Metadata</a></div> Comments in a computer program often store metadata about a program file. In particular, many <a href="/wiki/Software_maintainer" title="Software maintainer">software maintainers</a> put submission guidelines in comments to help people who read the source code of that program to send any improvements they make back to the maintainer. Other metadata includes: the name of the creator of the original version of the program file and the date when the first version was created, the name of the current maintainer of the program, the names of other people who have edited the program file so far, the URL of documentation about how to use the program, the name of the <a href="/wiki/Software_license" title="Software license">software license</a> for this program file, etc. When an algorithm in some section of the program is based on a description in a book or other reference, comments can be used to give the page number and title of the book or <a href="/wiki/Request_for_Comments" title="Request for Comments">Request for Comments</a> or other reference. <div class="mw-heading mw-heading3"><h3 id="Debugging">Debugging</h3>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=8" title="Edit section: Debugging">edit</a>]</div> A common developer practice is to comment out a code snippet, meaning to add comment syntax causing that block of code to become a comment, so that it will not be executed in the final program. This may be done to exclude certain pieces of code from the final program, or (more commonly) it can be used to find the source of an error. By systematically commenting out and running parts of the program, the source of an error can be determined, allowing it to be corrected. Many IDEs allow quick adding or removing such comments with single menu options or key combinations. The programmer has only to mark the part of text they want to (un)comment and choose the appropriate option. <div class="mw-heading mw-heading3"><h3 id="Automatic_documentation_generation">Automatic documentation generation</h3>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=9" title="Edit section: Automatic documentation generation">edit</a>]</div> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1236090951"><div role="note" class="hatnote navigation-not-searchable">Main article: <a href="/wiki/Documentation_generator" title="Documentation generator">Documentation generator</a></div> <a href="/wiki/Programming_tool" title="Programming tool">Programming tools</a> sometimes store documentation and <a href="/wiki/Metadata" title="Metadata">metadata</a> in comments.<a href="#cite_note-14">[14]</a> These may include insert positions for automatic header file inclusion, commands to set the file's <a href="/wiki/Syntax_highlighting" title="Syntax highlighting">syntax highlighting</a> mode,<a href="#cite_note-15">[15]</a> or the file's <a href="/wiki/Revision_control" class="mw-redirect" title="Revision control">revision number</a>.<a href="#cite_note-16">[16]</a> These functional control comments are also commonly referred to as <a href="/wiki/Annotation" title="Annotation">annotations</a>. Keeping documentation within source code comments is considered as one way to simplify the documentation process, as well as increase the chances that the documentation will be kept up to date with changes in the code.<a href="#cite_note-Ambler000-17">[17]</a> Examples of documentation generators include the programs <a href="/wiki/Javadoc" title="Javadoc">Javadoc</a> for use with <a href="/wiki/Java_(programming_language)" title="Java (programming language)">Java</a>, <a href="/wiki/Ddoc" title="Ddoc">Ddoc</a> for <a href="/wiki/D_(programming_language)" title="D (programming language)">D</a>, <a href="/wiki/Doxygen" title="Doxygen">Doxygen</a> for <a href="/wiki/C_(programming_language)" title="C (programming language)">C</a>, <a href="/wiki/C%2B%2B" title="C++">C++</a>, Java, <a href="/wiki/Interface_description_language" title="Interface description language">IDL</a>, <a href="/wiki/Visual_Expert" title="Visual Expert">Visual Expert</a> for <a href="/wiki/PL/SQL" title="PL/SQL">PL/SQL</a>, <a href="/wiki/Transact-SQL" title="Transact-SQL">Transact-SQL</a>, <a href="/wiki/PowerBuilder" title="PowerBuilder">PowerBuilder</a>, and <a href="/wiki/PHPDoc" title="PHPDoc">PHPDoc</a> for <a href="/wiki/PHP" title="PHP">PHP</a>. Forms of <a href="/wiki/Docstring" title="Docstring">docstring</a> are supported by <a href="/wiki/Python_(programming_language)" title="Python (programming language)">Python</a>, <a href="/wiki/Lisp_(programming_language)" title="Lisp (programming language)">Lisp</a>, <a href="/wiki/Elixir_(programming_language)" title="Elixir (programming language)">Elixir</a>, and <a href="/wiki/Clojure" title="Clojure">Clojure</a>.<a href="#cite_note-18">[18]</a> <a href="/wiki/C_Sharp_(programming_language)" title="C Sharp (programming language)">C#</a>, <a href="/wiki/F_Sharp_(programming_language)" title="F Sharp (programming language)">F#</a> and <a href="/wiki/Visual_Basic_.NET" class="mw-redirect" title="Visual Basic .NET">Visual Basic .NET</a> implement a similar feature called "XML Comments" which are read by <a href="/wiki/IntelliSense" class="mw-redirect" title="IntelliSense">IntelliSense</a> from the compiled <a href="/wiki/.NET" title=".NET">.NET</a> assembly.<a href="#cite_note-19">[19]</a> <div class="mw-heading mw-heading3"><h3 id="Syntax_extension">Syntax extension</h3>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=10" title="Edit section: Syntax extension">edit</a>]</div> Occasionally syntax elements that were originally intended to be comments are re-purposed to convey additional information to a program, such as "<a href="/wiki/Conditional_comment" title="Conditional comment">conditional comments</a>". Such "hot comments" may be the only practical solution that maintains backward-compatibility, but are widely regarded as a <a href="/wiki/Kludge" title="Kludge">kludge</a>.<a href="#cite_note-20">[20]</a> One specific example are docblocks, which are specially-formatted comments used to document a specific segment of code. This makes the DocBlock format independent of the target language (as long as it supports comments); however, it may also lead to multiple or inconsistent standards. <div class="mw-heading mw-heading3"><h3 id="Directive_uses">Directive uses</h3>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=11" title="Edit section: Directive uses">edit</a>]</div> There are cases where the normal comment characters are co-opted to create a special <a href="/wiki/Directive_(programming)" title="Directive (programming)">directive</a> for an editor or interpreter. Two examples of this directing an interpreter are: <ul><li>The Unix "<a href="/wiki/Shebang_(Unix)" title="Shebang (Unix)">shebang</a>" – <code>#!</code> – used on the first line of a script to point to the interpreter to be used.</li> <li>"Magic comments" identifying the encoding a source file is using,<a href="#cite_note-21">[21]</a> e.g. Python's PEP 263.<a href="#cite_note-22">[22]</a></li></ul> The script below for a Unix-like system shows both of these uses: <div class="mw-highlight mw-highlight-lang-python mw-content-ltr" dir="ltr"><pre>#!/usr/bin/env python3 # -*- coding: UTF-8 -*- print("Testing") </pre></div> Somewhat similar is the use of comments in C to communicate to a compiler that a default "fallthrough" in a <a href="/wiki/Case_statement" class="mw-redirect" title="Case statement">case statement</a> has been done deliberately: <div class="mw-highlight mw-highlight-lang-java mw-content-ltr mw-highlight-lines" dir="ltr"><pre>switch (command) { case CMD_SHOW_HELP_AND_EXIT: do_show_help(); /* Fall thru */ case CMD_EXIT: do_exit(); break; case CMD_OTHER: do_other(); break; /* ... etc. ... */ } </pre></div> Inserting such a <code>/* Fall thru */</code> comment for human readers was already a common convention, but in 2017 the <a href="/wiki/GNU_Compiler_Collection" title="GNU Compiler Collection">gcc</a> compiler began looking for these (or other indications of deliberate intent), and, if not found, emitting: "warning: this statement may fall through".<a href="#cite_note-23">[23]</a> Many editors and <a href="/wiki/Integrated_development_environment" title="Integrated development environment">IDEs</a> will read specially formatted comments. For example, the "modeline" feature of <a href="/wiki/Vim_(text_editor)" title="Vim (text editor)">Vim</a>; which would change its handling of tabs while editing a source with this comment included near the top of the file: <pre># vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4 </pre> <div class="mw-heading mw-heading3"><h3 id="Stress_relief">Stress relief</h3>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=12" title="Edit section: Stress relief">edit</a>]</div> Sometimes programmers will add comments as a way to relieve stress by commenting about development tools, competitors, employers, working conditions, or the quality of the code itself.<a href="#cite_note-24">[24]</a> The occurrence of this phenomenon can be easily seen from online resources that track <a href="/wiki/Profanity" title="Profanity">profanity</a> in source code.<a href="#cite_note-SwearWords-25">[25]</a> <div class="mw-heading mw-heading2"><h2 id="Normative_views">Normative views</h2>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=13" title="Edit section: Normative views">edit</a>]</div> There are various normative views and long-standing opinions regarding the proper use of comments in source code.<a href="#cite_note-26">[26]</a><a href="#cite_note-27">[27]</a> Some of these are informal and based on personal preference, while others are published or promulgated as formal guidelines for a particular community.<a href="#cite_note-28">[28]</a> <div class="mw-heading mw-heading3"><h3 id="Need_for_comments">Need for comments</h3>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=14" title="Edit section: Need for comments">edit</a>]</div> Experts have varying viewpoints on whether, and when, comments are appropriate in source code.<a href="#cite_note-BadComment000-9">[9]</a><a href="#cite_note-BadComments001-29">[29]</a> Some assert that source code should be written with few comments, on the basis that the source code should be self-explanatory or <a href="/wiki/Self-documenting" class="mw-redirect" title="Self-documenting">self-documenting</a>.<a href="#cite_note-BadComment000-9">[9]</a> Others suggest code should be extensively commented (it is not uncommon for over 50% of the non-<a href="/wiki/Whitespace_(computer_science)" class="mw-redirect" title="Whitespace (computer science)">whitespace</a> characters in source code to be contained within comments).<a href="#cite_note-Morelli000-30">[30]</a><a href="#cite_note-Javadoc000-31">[31]</a> In between these views is the assertion that comments are neither beneficial nor harmful by themselves, and what matters is that they are correct and kept in sync with the source code, and omitted if they are superfluous, excessive, difficult to maintain or otherwise unhelpful.<a href="#cite_note-techniques001-32">[32]</a><a href="#cite_note-CmmtPhilosophy-33">[33]</a> Comments are sometimes used to document contracts in the <a href="/wiki/Design_by_contract" title="Design by contract">design by contract</a> approach to programming. <div class="mw-heading mw-heading3"><h3 id="Level_of_detail">Level of detail</h3>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=15" title="Edit section: Level of detail">edit</a>]</div> Depending on the intended audience of the code and other considerations, the level of detail and description may vary considerably. For example, the following Java comment would be suitable in an introductory text designed to teach beginning programming: <div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre>String s = "Wikipedia"; /* Assigns the value "Wikipedia" to the variable s. */ </pre></div> This level of detail, however, would not be appropriate in the context of production code, or other situations involving experienced developers. Such rudimentary descriptions are inconsistent with the guideline: "Good comments ... clarify intent."<a href="#cite_note-GoodComment000-10">[10]</a> Further, for professional coding environments, the level of detail is ordinarily well defined to meet a specific performance requirement defined by business operations.<a href="#cite_note-Javadoc000-31">[31]</a> <div class="mw-heading mw-heading2"><h2 id="Styles">Styles</h2>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=16" title="Edit section: Styles">edit</a>]</div> There are many stylistic alternatives available when considering how comments should appear in source code. For larger projects involving a team of developers, comment styles are either agreed upon before a project starts, or evolve as a matter of convention or need as a project grows. Usually programmers prefer styles that are consistent, non-obstructive, easy to modify, and difficult to break.<a href="#cite_note-gnome000-34">[34]</a> <div class="mw-heading mw-heading3"><h3 id="Block_comment">Block comment</h3>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=17" title="Edit section: Block comment">edit</a>]</div> The following code fragments in C demonstrate just a tiny example of how comments can vary stylistically, while still conveying the same basic information: <div class="mw-highlight mw-highlight-lang-c mw-content-ltr" dir="ltr"><pre>/* This is the comment body. Variation One. */ </pre></div> <div class="mw-highlight mw-highlight-lang-c mw-content-ltr" dir="ltr"><pre>/***************************\ * * * This is the comment body. * * Variation Two. * * * \***************************/ </pre></div> Factors such as personal preference, flexibility of programming tools, and other considerations tend to influence the stylistic variants used in source code. For example, Variation Two might be disfavored among programmers who do not have <a href="/wiki/Source_code_editor" class="mw-redirect" title="Source code editor">source code editors</a> that can automate the alignment and visual appearance of text in comments. Software consultant and technology commentator <a href="/wiki/Allen_Holub" title="Allen Holub">Allen Holub</a><a href="#cite_note-Holub000-35">[35]</a> is one expert who advocates aligning the left edges of comments:<a href="#cite_note-Holub001-36">[36]</a> <div class="mw-highlight mw-highlight-lang-c mw-content-ltr" dir="ltr"><pre> /* This is the style recommended by Holub for C and C++. * It is demonstrated in ''Enough Rope'', in rule 29. */ </pre></div> <div class="mw-highlight mw-highlight-lang-c mw-content-ltr" dir="ltr"><pre> /* This is another way to do it, also in C. ** It is easier to do in editors that do not automatically indent the second ** through last lines of the comment one space from the first. ** It is also used in Holub's book, in rule 31. */ </pre></div> The use of /* and */ as block comment delimiters was inherited from PL/I into the B programming language, the immediate predecessor of the C programming language.<a href="#cite_note-Thompson1972-37">[37]</a> <div class="mw-heading mw-heading3"><h3 id="Line_comments">Line comments</h3>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=18" title="Edit section: Line comments">edit</a>]</div> Line comments generally use an arbitrary <a href="/wiki/Delimiter" title="Delimiter">delimiter</a> or sequence of <a href="/wiki/Token_(parser)" class="mw-redirect" title="Token (parser)">tokens</a> to indicate the beginning of a comment, and a <a href="/wiki/Newline" title="Newline">newline</a> character to indicate the end of a comment. In this example, all the text from the ASCII characters // to the end of the line is ignored. <div class="mw-highlight mw-highlight-lang-c mw-content-ltr" dir="ltr"><pre>// ------------------------- // This is the comment body. // ------------------------- </pre></div> Often such a comment has to begin at far left and extend to the whole line. However, in many languages, it is also possible to put a comment inline with a command line, to add a comment to it – as in this Perl example: <div class="mw-highlight mw-highlight-lang-perl mw-content-ltr" dir="ltr"><pre>print $s . "\n"; # Add a newline character after printing </pre></div> If a language allows both line comments and block comments, programming teams may decide upon a convention of using them differently: e.g. line comments only for minor comments, and block comments to describe higher-level abstractions. <div class="mw-heading mw-heading2"><h2 id="Tags">Tags</h2>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=19" title="Edit section: Tags">edit</a>]</div> Programmers may use informal <a href="/wiki/Tag_(metadata)" title="Tag (metadata)">tags</a> in comments to assist in indexing common issues. They may then be able to be searched for with common programming tools, such as the <a href="/wiki/Unix" title="Unix">Unix</a> <a href="/wiki/Grep" title="Grep">grep</a> utility or even <a href="/wiki/Syntax_highlighting" title="Syntax highlighting">syntax-highlighted</a> within <a href="/wiki/Text_editor" title="Text editor">text editors</a>. These are sometimes referred to as "codetags"<a href="#cite_note-38">[38]</a><a href="#cite_note-39">[39]</a> or "tokens", and the development tools might even assist you in listing all of them.<a href="#cite_note-40">[40]</a> Such tags differ widely, but might include: <ul><li>BUG, DEBUG — a known <a href="/wiki/Software_bug" title="Software bug">bug</a> that should be corrected.</li> <li>FIXME — should be corrected.</li> <li>HACK, BODGE, KLUDGE — a workaround.</li> <li>TODO — something to be done.</li> <li>NOTE — used to highlight especially notable <a href="/wiki/Gotcha_(programming)" title="Gotcha (programming)">gotchas</a>.</li> <li>UNDONE — a reversal or "roll back" of previous code.</li> <li>XXX — warn other programmers of problematic or misguiding code</li></ul> <div class="mw-heading mw-heading2"><h2 id="Examples">Examples</h2>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=20" title="Edit section: Examples">edit</a>]</div> <div class="mw-heading mw-heading3"><h3 id="Comparison">Comparison</h3>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=21" title="Edit section: Comparison">edit</a>]</div> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1236090951"><div role="note" class="hatnote navigation-not-searchable">Main article: <a href="/wiki/Comparison_of_programming_languages_(syntax)#Comments" title="Comparison of programming languages (syntax)">Comparison of programming languages (syntax) § Comments</a></div> Typographic conventions to specify comments vary widely. Further, individual programming languages sometimes provide unique variants. <div class="mw-heading mw-heading4"><h4 id="Ada">Ada</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=22" title="Edit section: Ada">edit</a>]</div> The <a href="/wiki/Ada_(programming_language)" title="Ada (programming language)">Ada</a> programming language uses '--' to indicate a comment up to the end of the line. For example: <div class="mw-highlight mw-highlight-lang-ada mw-content-ltr" dir="ltr"><pre> -- the air traffic controller task takes requests for takeoff and landing task type Controller (My_Runway: Runway_Access) is -- task entries for synchronous message passing entry Request_Takeoff (ID: in Airplane_ID; Takeoff: out Runway_Access); entry Request_Approach(ID: in Airplane_ID; Approach: out Runway_Access); end Controller; </pre></div> <div class="mw-heading mw-heading4"><h4 id="APL">APL</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=23" title="Edit section: APL">edit</a>]</div> <a href="/wiki/APL_(programming_language)" title="APL (programming language)">APL</a> uses <code>⍝</code> to indicate a comment up to the end of the line. For example: <div class="mw-highlight mw-highlight-lang-apl mw-content-ltr" dir="ltr"><pre>⍝ Now add the numbers: c←a+b ⍝ addition </pre></div> In dialects that have the <code>⊣</code> ("left") and <code>⊢</code> ("right") primitives, comments can often be inside or separate statements, in the form of ignored strings: <div class="mw-highlight mw-highlight-lang-apl mw-content-ltr" dir="ltr"><pre>d←2×c ⊣'where'⊢ c←a+ 'bound'⊢ b </pre></div> <div class="mw-heading mw-heading4"><h4 id="AppleScript">AppleScript</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=24" title="Edit section: AppleScript">edit</a>]</div> This section of <a href="/wiki/AppleScript" title="AppleScript">AppleScript</a> code shows the two styles of comments used in that language. <div class="mw-highlight mw-highlight-lang-applescript mw-content-ltr" dir="ltr"><pre>(* This program displays a greeting. *) on greet(myGreeting) display dialog myGreeting & " world!" end greet -- Show the greeting greet("Hello") </pre></div> <div class="mw-heading mw-heading4"><h4 id="BASIC">BASIC</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=25" title="Edit section: BASIC">edit</a>]</div> In this classic early <a href="/wiki/BASIC" title="BASIC">BASIC</a> code fragment the REM ("Remark") keyword is used to add comments. <div class="mw-highlight mw-highlight-lang-basic mw-content-ltr" dir="ltr"><pre>10 REM This BASIC program shows the use of the PRINT and GOTO Statements. 15 REM It fills the screen with the phrase "HELLO" 20 PRINT "HELLO" 30 GOTO 20 </pre></div> In later <a href="/wiki/Microsoft" title="Microsoft">Microsoft</a> BASICs, including <a href="/wiki/Quick_Basic" class="mw-redirect" title="Quick Basic">Quick Basic</a>, <a href="/wiki/Q_Basic" class="mw-redirect" title="Q Basic">Q Basic</a>, <a href="/wiki/Visual_Basic" title="Visual Basic">Visual Basic</a>, <a href="/wiki/Visual_Basic_.NET" class="mw-redirect" title="Visual Basic .NET">Visual Basic .NET</a>, and <a href="/wiki/VB_Script" class="mw-redirect" title="VB Script">VB Script</a>; and in descendants such as <a href="/wiki/FreeBASIC" title="FreeBASIC">FreeBASIC</a> and <a href="/wiki/Gambas" title="Gambas">Gambas</a> any text on a line after an ' (apostrophe) character is also treated as a comment. An example in Visual Basic .NET: <div class="mw-highlight mw-highlight-lang-vbnet mw-content-ltr" dir="ltr"><pre>Public Class Form1 Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click ' The following code is executed when the user ' clicks the button in the program's window. rem comments still exist. MessageBox.Show("Hello, World") 'Show a pop-up window with a greeting End Sub End Class </pre></div> <div class="mw-heading mw-heading4"><h4 id="C">C</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=26" title="Edit section: C">edit</a>]</div> This <a href="/wiki/C_(programming_language)" title="C (programming language)">C</a> code fragment demonstrates the use of a prologue comment or "block comment" to describe the purpose of a <a href="/wiki/Conditional_(programming)" class="mw-redirect" title="Conditional (programming)">conditional statement</a>. The comment explains key terms and concepts, and includes a short signature by the programmer who authored the code. <div class="mw-highlight mw-highlight-lang-c mw-content-ltr" dir="ltr"><pre> /* * Check if we are over our maximum process limit, but be sure to * exclude root. This is needed to make it possible for login and * friends to set the per-user process limit to something lower * than the amount of processes root is running. -- Rik */ if (atomic_read(&p->user->processes) >= p->rlim[RLIMIT_NPROC].rlim_cur && !capable(CAP_SYS_ADMIN) && !capable(CAP_SYS_RESOURCE)) goto bad_fork_free; </pre></div> Since C99, it has also been possible to use the // syntax from C++, indicating a single-line comment. The availability of block comments allows for marking structural breakouts, i.e. admissible violations of the single-entry/single-exit rule of <a href="/wiki/Structured_Programming" class="mw-redirect" title="Structured Programming">Structured Programming</a>, visibly, like in the following example: <div class="mw-highlight mw-highlight-lang-c mw-content-ltr" dir="ltr"><pre>static Edge edge_any(Node n, Node m) { // Returns whether any edge is between nodes $n and $m. Edge e; for (e=n->edges; e; e=e->next) { if (e->dst == m) { /*********/ return e; } } for (e=m->edges; e; e=e->next) { if (e->dst == n) { /*****/ break; } } return e; } </pre></div> In many languages lacking a block comment, e.g. <a href="/wiki/AWK" title="AWK">awk</a>, you can use sequences of statement separators like <code>;</code> instead. But it's impossible in languages using indentation as a rigid indication of intended block structure, like <a href="/wiki/Python_(programming_language)" title="Python (programming language)">Python</a>. <div class="mw-heading mw-heading4"><h4 id="Cisco_IOS_and_IOS-XE_configuration">Cisco IOS and IOS-XE configuration</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=27" title="Edit section: Cisco IOS and IOS-XE configuration">edit</a>]</div> The <a href="/wiki/Exclamation_point" class="mw-redirect" title="Exclamation point">exclamation point</a> (!) may be used to mark comments in a Cisco router's configuration mode, however such comments are not saved to <a href="/wiki/Non-volatile_memory" title="Non-volatile memory">non-volatile memory</a> (which contains the startup-config), nor are they displayed by the "show run" command.<a href="#cite_note-41">[41]</a><a href="#cite_note-42">[42]</a> It is possible to insert <a href="/wiki/Human-readable" class="mw-redirect" title="Human-readable">human-readable</a> content that is actually part of the configuration, and may be saved to the <a href="/wiki/NVRAM" class="mw-redirect" title="NVRAM">NVRAM</a> startup-config via: <ul><li>The "description" command, used to add a description to the configuration of an interface or of a <a href="/wiki/BGP" class="mw-redirect" title="BGP">BGP</a> neighbor</li> <li>The "name" parameter, to add a remark to a static route</li> <li>The "remark" command in access lists</li></ul> <div class="mw-highlight mw-highlight-lang-text mw-content-ltr" dir="ltr"><pre>! Paste the text below to reroute traffic manually config t int gi0/2 no shut ip route 0.0.0.0 0.0.0.0 gi0/2 name ISP2 no ip route 0.0.0.0 0.0.0.0 gi0/1 name ISP1 int gi0/1 shut exit </pre></div> <div class="mw-heading mw-heading4"><h4 id="ColdFusion">ColdFusion</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=28" title="Edit section: ColdFusion">edit</a>]</div> <a href="/wiki/ColdFusion" class="mw-redirect" title="ColdFusion">ColdFusion</a> uses comments similar to <a href="/wiki/HTML_comment" class="mw-redirect" title="HTML comment">HTML comments</a>, but instead of two dashes, it uses three. These comments are caught by the ColdFusion engine and not printed to the browser. Such comments are nestable. <div class="mw-highlight mw-highlight-lang-cfm mw-content-ltr" dir="ltr"><pre>  ---> <cfoutput> Hello World<br /> </cfoutput> </pre></div> <div class="mw-heading mw-heading4"><h4 id="D">D</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=29" title="Edit section: D">edit</a>]</div> <a href="/wiki/D_(programming_language)" title="D (programming language)">D</a> uses C++-style comments, as well as nestable D-style multiline comments, which start with '/+' and end with '+/'. <div class="mw-highlight mw-highlight-lang-d mw-content-ltr" dir="ltr"><pre>// This is a single-line comment. /* This is a multiline comment. */ /+ This is a /+ nested +/ comment +/ </pre></div> <div class="mw-heading mw-heading4"><h4 id="Fortran_IV">Fortran IV</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=30" title="Edit section: Fortran IV">edit</a>]</div> This <a href="/wiki/Fortran_IV" class="mw-redirect" title="Fortran IV">Fortran IV</a> code fragment demonstrates how comments are used in that language, which is very column-oriented. A letter "C" in column 1 causes the entire line to be treated as a comment. <div class="mw-highlight mw-highlight-lang-fortranfixed mw-content-ltr" dir="ltr"><pre>C C Lines that begin with 'C' (in the first or 'comment' column) are comments C WRITE (6,610) 610 FORMAT(12H HELLO WORLD) END </pre></div> Note that the columns of a line are otherwise treated as four fields: 1 to 5 is the label field, 6 causes the line to be taken as a continuation of the previous statement; and declarations and statements go in 7 to 72. <div class="mw-heading mw-heading4"><h4 id="Fortran_90">Fortran 90</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=31" title="Edit section: Fortran 90">edit</a>]</div> This <a href="/wiki/Fortran" title="Fortran">Fortran</a> code fragment demonstrates how comments are used in that language, with the comments themselves describing the basic formatting rules. <div class="mw-highlight mw-highlight-lang-fortran mw-content-ltr" dir="ltr"><pre>!* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * !* All characters after an exclamation mark are considered as comments * !* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * program comment_test print '(A)', 'Hello world' ! Fortran 90 introduced the option for inline comments. end program </pre></div> <div class="mw-heading mw-heading4"><h4 id="Haskell">Haskell</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=32" title="Edit section: Haskell">edit</a>]</div> Line comments in Haskell start with '--' (two hyphens) until the end of line, and multiple line comments start with '{-' and end with '-}'. <div class="mw-highlight mw-highlight-lang-haskell mw-content-ltr" dir="ltr"><pre>{- this is a comment on more lines -} -- and this is a comment on one line putStrLn "Wikipedia" -- this is another comment </pre></div> Haskell also provides a <a href="/wiki/Literate_programming" title="Literate programming">literate programming</a> method of commenting known as "Bird Style".<a href="#cite_note-43">[43]</a> In this all lines starting with > are interpreted as code, everything else is considered a comment. One additional requirement is that you always leave a blank line before and after the code block: <div class="mw-highlight mw-highlight-lang-lhaskell mw-content-ltr" dir="ltr"><pre>In Bird-style you have to leave a blank before the code. > fact :: Integer -> Integer > fact 0 = 1 > fact (n+1) = (n+1) * fact n And you have to leave a blank line after the code as well. </pre></div> Literate programming can also be done in Haskell, using <a href="/wiki/LaTeX" title="LaTeX">LaTeX</a>. The code environment can be used instead of the Richard Bird's style: In <a href="/wiki/LaTeX" title="LaTeX">LaTeX</a> style this is equivalent to the above example, the code environment could be defined in the LaTeX preamble. Here is a simple definition: <div class="mw-highlight mw-highlight-lang-lhaskell mw-content-ltr" dir="ltr"><pre>\usepackage{verbatim} \newenvironment{code}{\verbatim}{\endverbatim} </pre></div> later in <div class="mw-highlight mw-highlight-lang-lhaskell mw-content-ltr" dir="ltr"><pre>% the LaTeX source file The \verb|fact n| function call computes $n!$ if $n\ge 0$, here is a definition:\\ \begin{code} fact :: Integer -> Integer fact 0 = 1 fact (n+1) = (n+1) * fact n \end{code} Here more explanation using \LaTeX{} markup </pre></div> <div class="mw-heading mw-heading4"><h4 id="Java">Java</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=33" title="Edit section: Java">edit</a>]</div> This <a href="/wiki/Java_(programming_language)" title="Java (programming language)">Java</a> code fragment shows a block comment used to describe the <code>setToolTipText</code> method. The formatting is consistent with <a href="/wiki/Sun_Microsystems" title="Sun Microsystems">Sun Microsystems</a> <a href="/wiki/Javadoc" title="Javadoc">Javadoc</a> standards. The comment is designed to be read by the Javadoc processor. <div class="mw-highlight mw-highlight-lang-java mw-content-ltr" dir="ltr"><pre>/** * This is a block comment in Java. * The setToolTipText method registers the text to display in a tool tip. * The text is displayed when the cursor lingers over the component. * * @param text The string to be displayed. If 'text' is null, * the tool tip is turned off for this component. */ public void setToolTipText(String text) { // This is an inline comment in Java. TODO: Write code for this method. } </pre></div> <div class="mw-heading mw-heading4"><h4 id="JavaScript">JavaScript</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=34" title="Edit section: JavaScript">edit</a>]</div> <a href="/wiki/JavaScript_(programming_language)" class="mw-redirect" title="JavaScript (programming language)">JavaScript</a> uses // to precede comments and /* */ for multi-line comments. <div class="mw-highlight mw-highlight-lang-javascript mw-content-ltr" dir="ltr"><pre>// A single line JavaScript comment var iNum = 100; var iTwo = 2; // A comment at the end of line /* multi-line JavaScript comment */ </pre></div> <div class="mw-heading mw-heading4"><h4 id="Lua">Lua</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=35" title="Edit section: Lua">edit</a>]</div> The <a href="/wiki/Lua_(programming_language)" title="Lua (programming language)">Lua</a> programming language uses double-hyphens, <code>--</code>, for single line comments in a similar way to <a href="/wiki/Ada_(programming_language)" title="Ada (programming language)">Ada</a>, <a href="/wiki/Eiffel_(programming_language)" title="Eiffel (programming language)">Eiffel</a>, <a href="/wiki/Haskell_(programming_language)" class="mw-redirect" title="Haskell (programming language)">Haskell</a>, <a href="/wiki/SQL" title="SQL">SQL</a> and <a href="/wiki/VHDL" title="VHDL">VHDL</a> languages. Lua also has block comments, which start with <code>--[[</code> and run until a closing <code>]]</code> For example: <div class="mw-highlight mw-highlight-lang-lua mw-content-ltr" dir="ltr"><pre>--[[A multi-line long comment ]] print(20) -- print the result </pre></div> A common technique to comment out a piece of code,<a href="#cite_note-44">[44]</a> is to enclose the code between <code>--[[</code> and <code>--]]</code>, as below: <div class="mw-highlight mw-highlight-lang-lua mw-content-ltr" dir="ltr"><pre>--[[ print(10) --]] -- no action (commented out) </pre></div> In this case, it's possible to reactivate the code by adding a single hyphen to the first line: <div class="mw-highlight mw-highlight-lang-lua mw-content-ltr" dir="ltr"><pre>---[[ print(10) --]] --> 10 </pre></div> In the first example, the <code>--[[</code> in the first line starts a long comment, and the two hyphens in the last line are still inside that comment. In the second example, the sequence <code>---[[</code> starts an ordinary, single-line comment, so that the first and the last lines become independent comments. In this case, the <code>print</code> is outside comments. In this case, the last line becomes an independent comment, as it starts with <code>--</code>. Long comments in Lua can be more complex than these, as you can read in the section called "Long strings" c.f. Programming in Lua. <div class="mw-heading mw-heading4"><h4 id="MATLAB">MATLAB</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=36" title="Edit section: MATLAB">edit</a>]</div> In <a href="/wiki/MATLAB" title="MATLAB">MATLAB</a>'s programming language, the '%' character indicates a single-line comment. Multi line comments are also available via %{ and %} brackets and can be nested, e.g. <div class="mw-highlight mw-highlight-lang-matlab mw-content-ltr" dir="ltr"><pre>% These are the derivatives for each term d = [0 -1 0]; %{  %{ (Example of a nested comment, indentation is for cosmetics (and ignored).)  %} We form the sequence, following the Taylor formula. Note that we're operating on a vector. %} seq = d .* (x - c).^n ./(factorial(n)) % We add-up to get the Taylor approximation approx = sum(seq) </pre></div> <div class="mw-heading mw-heading4"><h4 id="Nim">Nim</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=37" title="Edit section: Nim">edit</a>]</div> <a href="/wiki/Nim_(programming_language)" title="Nim (programming language)">Nim</a> uses the '#' character for inline comments. Multi-line block comments are opened with '#[' and closed with ']#'. Multi-line block comments can be nested. Nim also has documentation comments that use mixed <a href="/wiki/Markdown" title="Markdown">Markdown</a> and <a href="/wiki/ReStructuredText" title="ReStructuredText">ReStructuredText</a> markups. The inline documentation comments use '##' and multi-line block documentation comments are opened with '##[' and closed with ']##'. The compiler can generate <a href="/wiki/HTML" title="HTML">HTML</a>, <a href="/wiki/LaTeX" title="LaTeX">LaTeX</a> and <a href="/wiki/JSON" title="JSON">JSON</a> documentation from the documentation comments. Documentation comments are part of the <a href="/wiki/Abstract_syntax_tree" title="Abstract syntax tree">abstract syntax tree</a> and can be extracted using macros.<a href="#cite_note-45">[45]</a> <div class="mw-highlight mw-highlight-lang-nim mw-content-ltr" dir="ltr"><pre>## Documentation of the module *ReSTructuredText* and **MarkDown** # This is a comment, but it is not a documentation comment. type Kitten = object ## Documentation of type age: int ## Documentation of field proc purr(self: Kitten) = ## Documentation of function echo "Purr Purr" # This is a comment, but it is not a documentation comment. # This is a comment, but it is not a documentation comment. </pre></div> <div class="mw-heading mw-heading4"><h4 id="OCaml">OCaml</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=38" title="Edit section: OCaml">edit</a>]</div> <a href="/wiki/OCaml" title="OCaml">OCaml</a> uses nestable comments, which is useful when commenting a code block. <div class="mw-highlight mw-highlight-lang-ocaml mw-content-ltr" dir="ltr"><pre>codeLine(* comment level 1(*comment level 2*)*) </pre></div> <div class="mw-heading mw-heading4"><h4 id="Pascal,_Delphi">Pascal, Delphi</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=39" title="Edit section: Pascal, Delphi">edit</a>]</div> In <a href="/wiki/Pascal_(programming_language)" title="Pascal (programming language)">Pascal</a> and <a href="/wiki/Delphi_(software)" title="Delphi (software)">Delphi</a>, comments are delimited by '{ ... }'. Comment lines can also start with '\\' . As an alternative, for computers that do not support these characters, '(* ... *)' are allowed.<a href="#cite_note-46">[46]</a> In <a href="/wiki/Niklaus_Wirth" title="Niklaus Wirth">Niklaus Wirth</a>'s more modern family of languages (including <a href="/wiki/Modula-2" title="Modula-2">Modula-2</a> and <a href="/wiki/Oberon_(programming_language)" title="Oberon (programming language)">Oberon</a>), comments are delimited by '(* ... *)'.<a href="#cite_note-47">[47]</a><a href="#cite_note-48">[48]</a> For example: <div class="mw-highlight mw-highlight-lang-pascal mw-content-ltr" dir="ltr"><pre>(* test diagonals *) columnDifference := testColumn - column; if (row + columnDifference = testRow) or ....... </pre></div> Comments can be nested. // can be included in a {} and {} can be included in a (**). <div class="mw-heading mw-heading4"><h4 id="Perl">Perl</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=40" title="Edit section: Perl">edit</a>]</div> Line comments in <a href="/wiki/Perl" title="Perl">Perl</a>, and many other <a href="/wiki/Scripting_language" title="Scripting language">scripting languages</a>, begin with a hash (#) symbol. <div class="mw-highlight mw-highlight-lang-perl mw-content-ltr" dir="ltr"><pre># A simple example # my $s = "Wikipedia"; # Sets the variable s to "Wikipedia". print $s . "\n"; # Add a newline character after printing </pre></div> Instead of a regular block commenting construct, Perl uses <a href="/wiki/Plain_Old_Documentation" title="Plain Old Documentation">Plain Old Documentation</a>, a markup language for <a href="/wiki/Literate_programming" title="Literate programming">literate programming</a>,<a href="#cite_note-49">[49]</a> for instance:<a href="#cite_note-50">[50]</a> <div class="mw-highlight mw-highlight-lang-perl mw-content-ltr" dir="ltr"><pre>=item Pod::List-E<gt>new() Create a new list object. Properties may be specified through a hash reference like this: my $list = Pod::List->new({ -start => $., -indent => 4 }); See the individual methods/properties for details. =cut sub new { my $this = shift; my $class = ref($this) || $this; my %params = @_; my $self = {%params}; bless $self, $class; $self->initialize(); return $self; } </pre></div> <div class="mw-heading mw-heading4"><h4 id="R">R</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=41" title="Edit section: R">edit</a>]</div> <a href="/wiki/R_(programming_language)" title="R (programming language)">R</a> only supports inline comments started by the hash (#) character. <div class="mw-highlight mw-highlight-lang-r mw-content-ltr" dir="ltr"><pre># This is a comment print("This is not a comment") # This is another comment </pre></div> <div class="mw-heading mw-heading4"><h4 id="Raku">Raku</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=42" title="Edit section: Raku">edit</a>]</div> <a href="/wiki/Raku_(programming_language)" title="Raku (programming language)">Raku</a> (previously called Perl 6) uses the same line comments and POD Documentation comments as regular <a href="/wiki/Perl" title="Perl">Perl</a> (see Perl section above), but adds a configurable block comment type: "multi-line / embedded comments".<a href="#cite_note-perl6-51">[51]</a> These start with a hash character, followed by a backtick, and then some opening bracketing character, and end with the matching closing bracketing character.<a href="#cite_note-perl6-51">[51]</a> The content can not only span multiple lines, but can also be embedded inline. <div class="mw-highlight mw-highlight-lang-perl6 mw-content-ltr" dir="ltr"><pre>#`{{ "commenting out" this version toggle-case(Str:D $s) Toggles the case of each character in a string: my Str $toggled-string = toggle-case("mY NAME IS mICHAEL!"); }} sub toggle-case(Str:D $s) #`( this version of parens is used now ){ ... } </pre></div> <div class="mw-heading mw-heading4"><h4 id="PHP">PHP</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=43" title="Edit section: PHP">edit</a>]</div> Comments in <a href="/wiki/PHP" title="PHP">PHP</a> can be either in C++ style (both inline and block), or use hashes. <a href="/wiki/PHPDoc" title="PHPDoc">PHPDoc</a> is a style adapted from Javadoc and is a common standard for documenting PHP code. Starting in PHP 8, the # sign can only mean a comment if it's not immediately followed by '['. Otherwise, it will mean a function attribute, which runs until ']': <div class="mw-highlight mw-highlight-lang-php mw-content-ltr" dir="ltr"><pre>/** * This class contains a sample documentation. * * @author Unknown */ #[Attribute] class MyAttribute { const VALUE = 'value'; // This is an inline comment. It starts with '//', like in C++. private $value; # This is a Unix-style inline comment, which starts with '#'. public function __construct($value = null) { $this->value = $value; } /* This is a multiline comment. These comments cannot be nested. */ } </pre></div> <div class="mw-heading mw-heading4"><h4 id="PowerShell">PowerShell</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=44" title="Edit section: PowerShell">edit</a>]</div> Comments in <a href="/wiki/Windows_PowerShell" class="mw-redirect" title="Windows PowerShell">Windows PowerShell</a> <div class="mw-highlight mw-highlight-lang-powershell mw-content-ltr" dir="ltr"><pre># Single line comment Write-Host "Hello, World!" <# Multi Line Comment #> Write-Host "Goodbye, world!" </pre></div> <div class="mw-heading mw-heading4"><h4 id="Python">Python</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=45" title="Edit section: Python">edit</a>]</div> Inline comments in <a href="/wiki/Python_(programming_language)" title="Python (programming language)">Python</a> use the hash (#) character, as in the two examples in this code: <div class="mw-highlight mw-highlight-lang-python mw-content-ltr" dir="ltr"><pre># This program prints "Hello World" to the screen print("Hello World!") # Note the new syntax </pre></div> Block comments, as defined in this article, do not technically exist in Python.<a href="#cite_note-triple-52">[52]</a> A bare <a href="/wiki/String_literal" title="String literal">string literal</a> represented by a triple-quoted string can be used,<a href="#cite_note-53">[53]</a> but is not ignored by the interpreter in the same way that "#" comment is.<a href="#cite_note-triple-52">[52]</a> In the examples below, the triple double-quoted strings act in this way as comments, but are also treated as <a href="/wiki/Docstring" title="Docstring">docstrings</a>: <div class="mw-highlight mw-highlight-lang-python mw-content-ltr" dir="ltr"><pre>""" Assuming this is file mymodule.py, then this string, being the first statement in the file, will become the "mymodule" module's docstring when the file is imported. """ class MyClass: """The class's docstring""" def my_method(self): """The method's docstring""" def my_function(): """The function's docstring""" </pre></div> <div class="mw-heading mw-heading4"><h4 id="Ruby">Ruby</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=46" title="Edit section: Ruby">edit</a>]</div> Inline comments in <a href="/wiki/Ruby_(programming_language)" title="Ruby (programming language)">Ruby</a> start with the # character. To create a multiline comment, one must place "=begin" at the start of a line, and then everything until "=end" that starts a line is ignored. Including a space after the equals sign in this case throws a syntax error. <div class="mw-highlight mw-highlight-lang-ruby mw-content-ltr" dir="ltr"><pre>puts "This is not a comment" # this is a comment puts "This is not a comment" =begin whatever goes in these lines is just for the human reader =end puts "This is not a comment" </pre></div> <div class="mw-heading mw-heading4"><h4 id="SQL">SQL</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=47" title="Edit section: SQL">edit</a>]</div> Standard comments in SQL are in single-line-only form, using two dashes: <div class="mw-highlight mw-highlight-lang-sql mw-content-ltr" dir="ltr"><pre>-- This is a single line comment -- followed by a second line SELECT COUNT(*) FROM Authors WHERE Authors.name = 'Smith'; -- Note: we only want 'smith' -- this comment appears after SQL code </pre></div> Alternatively, a comment format syntax identical to the "block comment" style used in the syntax for C and Java is supported by <a href="/wiki/Transact-SQL" title="Transact-SQL">Transact-SQL</a>, <a href="/wiki/MySQL" title="MySQL">MySQL</a>, <a href="/wiki/SQLite" title="SQLite">SQLite</a>, <a href="/wiki/PostgreSQL" title="PostgreSQL">PostgreSQL</a>, and <a href="/wiki/Oracle_Database" title="Oracle Database">Oracle</a>.<a href="#cite_note-MSSQL-54">[54]</a><a href="#cite_note-MySQL-55">[55]</a><a href="#cite_note-SQLite-56">[56]</a><a href="#cite_note-PostgreSQL-57">[57]</a><a href="#cite_note-Oracle-58">[58]</a> MySQL also supports comments from the hash (#) character to the end of the line. <div class="mw-heading mw-heading4"><h4 id="Swift">Swift</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=48" title="Edit section: Swift">edit</a>]</div> Single-line comments begin with two forward-slashes (//):<div class="mw-highlight mw-highlight-lang-swift mw-content-ltr" dir="ltr"><pre>// This is a comment. </pre></div>Multiline comments start with a forward-slash followed by an asterisk (/*) and end with an asterisk followed by a forward-slash (*/):<div class="mw-highlight mw-highlight-lang-swift mw-content-ltr" dir="ltr"><pre>/* This is also a comment but is written over multiple lines. */ </pre></div>Multiline comments in Swift can be nested inside other multiline comments. You write nested comments by starting a multiline comment block and then starting a second multiline comment within the first block. The second block is then closed, followed by the first block:<div class="mw-highlight mw-highlight-lang-swift mw-content-ltr" dir="ltr"><pre>/* This is the start of the first multiline comment. /* This is the second, nested multiline comment. */ This is the end of the first multiline comment. */ </pre></div> <div class="mw-heading mw-heading4"><h4 id="XML_(or_HTML)">XML (or HTML)</h4>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=49" title="Edit section: XML (or HTML)">edit</a>]</div> Comments in <a href="/wiki/XML" title="XML">XML</a> (or HTML) are introduced with <div class="mw-highlight mw-highlight-lang-xml mw-content-ltr" dir="ltr"><pre> </pre></div> For example, <div class="mw-highlight mw-highlight-lang-xml mw-content-ltr" dir="ltr"><pre> <param name="context" value="public" /> </pre></div> For compatibility with <a href="/wiki/SGML" class="mw-redirect" title="SGML">SGML</a>, the string "--" (double-hyphen) is not allowed inside comments. <div class="mw-heading mw-heading2"><h2 id="Security_issues">Security issues</h2>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=50" title="Edit section: Security issues">edit</a>]</div> In <a href="/wiki/Interpreted_language" class="mw-redirect" title="Interpreted language">interpreted languages</a> the comments are viewable to the end user of the program. In some cases, such as sections of code that are "commented out", this may present a security <a href="/wiki/Vulnerability_(computing)" class="mw-redirect" title="Vulnerability (computing)">vulnerability</a>.<a href="#cite_note-InsecureComments-59">[59]</a> <div class="mw-heading mw-heading2"><h2 id="See_also">See also</h2>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=51" title="Edit section: See also">edit</a>]</div> <ul><li><a href="/wiki/Docstring" title="Docstring">Docstring</a>, a specific type of comment that is parsed and retained throughout the runtime of the program.</li> <li><a href="/wiki/Shebang_(Unix)" title="Shebang (Unix)">Shebang</a>, the use of #! as an interpreter directive in scripts on Unix-like systems</li> <li><a href="/wiki/HTML_comment_tag" class="mw-redirect" title="HTML comment tag">HTML comment tag</a></li> <li><a href="/wiki/Literate_programming" title="Literate programming">Literate programming</a>, alternative documentation <a href="/wiki/Programming_paradigm" title="Programming paradigm">paradigm</a></li> <li><a href="/wiki/Comparison_of_programming_languages_(syntax)#Comments" title="Comparison of programming languages (syntax)">Syntax of comments</a> in various programming languages</li> <li><a href="/wiki/COMMENT_(CONFIG.SYS_directive)" class="mw-redirect" title="COMMENT (CONFIG.SYS directive)">COMMENT (CONFIG.SYS directive)</a></li> <li><a href="/wiki/REM_(CONFIG.SYS_directive)" class="mw-redirect" title="REM (CONFIG.SYS directive)">REM (CONFIG.SYS directive)</a></li></ul> <div class="mw-heading mw-heading2"><h2 id="Notes_and_references">Notes and references</h2>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=52" title="Edit section: Notes and references">edit</a>]</div> <style data-mw-deduplicate="TemplateStyles:r1239543626">.mw-parser-output .reflist{margin-bottom:0.5em;list-style-type:decimal}@media screen{.mw-parser-output .reflist{font-size:90%}}.mw-parser-output .reflist .references{font-size:100%;margin-bottom:0;list-style-type:inherit}.mw-parser-output .reflist-columns-2{column-width:30em}.mw-parser-output .reflist-columns-3{column-width:25em}.mw-parser-output .reflist-columns{margin-top:0.3em}.mw-parser-output .reflist-columns ol{margin-top:0}.mw-parser-output .reflist-columns li{page-break-inside:avoid;break-inside:avoid-column}.mw-parser-output .reflist-upper-alpha{list-style-type:upper-alpha}.mw-parser-output .reflist-upper-roman{list-style-type:upper-roman}.mw-parser-output .reflist-lower-alpha{list-style-type:lower-alpha}.mw-parser-output .reflist-lower-greek{list-style-type:lower-greek}.mw-parser-output .reflist-lower-roman{list-style-type:lower-roman}</style><div class="reflist reflist-columns references-column-width reflist-columns-2"> <ol class="references"> <li id="cite_note-PennyGrubb000-1"><a href="#cite_ref-PennyGrubb000_1-0">^</a> Source code can be divided into program code (which consists of machine-translatable instructions); and comments (which include human-readable notes and other kinds of annotations in support of the program code).<style data-mw-deduplicate="TemplateStyles:r1238218222">.mw-parser-output cite.citation{font-style:inherit;word-wrap:break-word}.mw-parser-output .citation q{quotes:"\"""\"""'""'"}.mw-parser-output .citation:target{background-color:rgba(0,127,255,0.133)}.mw-parser-output .id-lock-free.id-lock-free a{background:url("//upload.wikimedia.org/wikipedia/commons/6/65/Lock-green.svg")right 0.1em center/9px no-repeat}.mw-parser-output .id-lock-limited.id-lock-limited a,.mw-parser-output .id-lock-registration.id-lock-registration a{background:url("//upload.wikimedia.org/wikipedia/commons/d/d6/Lock-gray-alt-2.svg")right 0.1em center/9px no-repeat}.mw-parser-output .id-lock-subscription.id-lock-subscription a{background:url("//upload.wikimedia.org/wikipedia/commons/a/aa/Lock-red-alt-2.svg")right 0.1em center/9px no-repeat}.mw-parser-output .cs1-ws-icon a{background:url("//upload.wikimedia.org/wikipedia/commons/4/4c/Wikisource-logo.svg")right 0.1em center/12px no-repeat}body:not(.skin-timeless):not(.skin-minerva) .mw-parser-output .id-lock-free a,body:not(.skin-timeless):not(.skin-minerva) .mw-parser-output .id-lock-limited a,body:not(.skin-timeless):not(.skin-minerva) .mw-parser-output .id-lock-registration a,body:not(.skin-timeless):not(.skin-minerva) .mw-parser-output .id-lock-subscription a,body:not(.skin-timeless):not(.skin-minerva) .mw-parser-output .cs1-ws-icon a{background-size:contain;padding:0 1em 0 0}.mw-parser-output .cs1-code{color:inherit;background:inherit;border:none;padding:inherit}.mw-parser-output .cs1-hidden-error{display:none;color:var(--color-error,#d33)}.mw-parser-output .cs1-visible-error{color:var(--color-error,#d33)}.mw-parser-output .cs1-maint{display:none;color:#085;margin-left:0.3em}.mw-parser-output .cs1-kern-left{padding-left:0.2em}.mw-parser-output .cs1-kern-right{padding-right:0.2em}.mw-parser-output .citation .mw-selflink{font-weight:inherit}@media screen{.mw-parser-output .cs1-format{font-size:95%}html.skin-theme-clientpref-night .mw-parser-output .cs1-maint{color:#18911f}}@media screen and (prefers-color-scheme:dark){html.skin-theme-clientpref-os .mw-parser-output .cs1-maint{color:#18911f}}</style><cite id="CITEREFPenny_Grubb2003" class="citation book cs1">Penny Grubb, Armstrong Takang (2003). Software Maintenance: Concepts and Practice. World Scientific. pp. 7, plese start120–121. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-981-238-426-3" title="Special:BookSources/978-981-238-426-3"><bdi>978-981-238-426-3</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Software+Maintenance%3A+Concepts+and+Practice&rft.pages=7%2C+plese+start120-121&rft.pub=World+Scientific&rft.date=2003&rft.isbn=978-981-238-426-3&rft.aulast=Penny+Grubb&rft.aufirst=Armstrong+Takang&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-2"><a href="#cite_ref-2">^</a> For purposes of this article, programming language comments are treated as indistinct from comments that appear in <a href="/wiki/Markup_language" title="Markup language">markup languages</a>, <a href="/wiki/Configuration_file" title="Configuration file">configuration files</a> and other similar contexts. Moreover, markup language is often closely integrated with programming language code, especially in the context of <a href="/wiki/Automatic_programming" title="Automatic programming">code generation</a>. See e.g., <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFGanguli2002" class="citation book cs1">Ganguli, Madhushree (2002). Making Use of Jsp. New York: Wiley. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-0-471-21974-3" title="Special:BookSources/978-0-471-21974-3"><bdi>978-0-471-21974-3</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Making+Use+of+Jsp&rft.place=New+York&rft.pub=Wiley&rft.date=2002&rft.isbn=978-0-471-21974-3&rft.aulast=Ganguli&rft.aufirst=Madhushree&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988">, <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFHewitt2003" class="citation book cs1">Hewitt, Eben (2003). Java for Coldfusion Developers. Upper Saddle River: Pearson Education. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-0-13-046180-3" title="Special:BookSources/978-0-13-046180-3"><bdi>978-0-13-046180-3</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Java+for+Coldfusion+Developers&rft.place=Upper+Saddle+River&rft.pub=Pearson+Education&rft.date=2003&rft.isbn=978-0-13-046180-3&rft.aulast=Hewitt&rft.aufirst=Eben&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-JBDixit000-3"><a href="#cite_ref-JBDixit000_3-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFDixit2003" class="citation book cs1">Dixit, J.B. (2003). Computer Fundamentals and Programming in C. Laxmi Publications. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-81-7008-882-0" title="Special:BookSources/978-81-7008-882-0"><bdi>978-81-7008-882-0</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Computer+Fundamentals+and+Programming+in+C&rft.pub=Laxmi+Publications&rft.date=2003&rft.isbn=978-81-7008-882-0&rft.aulast=Dixit&rft.aufirst=J.B.&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-Higham000-4"><a href="#cite_ref-Higham000_4-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFHigham2005" class="citation book cs1">Higham, Desmond (2005). MATLAB Guide. SIAM. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-0-89871-578-1" title="Special:BookSources/978-0-89871-578-1"><bdi>978-0-89871-578-1</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=MATLAB+Guide&rft.pub=SIAM&rft.date=2005&rft.isbn=978-0-89871-578-1&rft.aulast=Higham&rft.aufirst=Desmond&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-Vermeulen000-5"><a href="#cite_ref-Vermeulen000_5-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFVermeulen2000" class="citation book cs1">Vermeulen, Al (2000). <a rel="nofollow" class="external text" href="https://archive.org/details/elementsofjavast00verm">The Elements of Java Style</a>. Cambridge University Press. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-0-521-77768-1" title="Special:BookSources/978-0-521-77768-1"><bdi>978-0-521-77768-1</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=The+Elements+of+Java+Style&rft.pub=Cambridge+University+Press&rft.date=2000&rft.isbn=978-0-521-77768-1&rft.aulast=Vermeulen&rft.aufirst=Al&rft_id=https%3A%2F%2Farchive.org%2Fdetails%2Felementsofjavast00verm&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-javadude000-6">^ <a href="#cite_ref-javadude000_6-0">a</a> <a href="#cite_ref-javadude000_6-1">b</a> <a href="#cite_ref-javadude000_6-2">c</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="http://javadude.com/articles/comments.html">"Using the right comment in Java"</a>. 2000-03-04. Retrieved 2007-07-24.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=Using+the+right+comment+in+Java&rft.date=2000-03-04&rft_id=http%3A%2F%2Fjavadude.com%2Farticles%2Fcomments.html&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-Dietrich000-7"><a href="#cite_ref-Dietrich000_7-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFW._R.2003" class="citation book cs1">W. R., Dietrich (2003). Applied Pattern Recognition: Algorithms and Implementation in C++. Springer. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-3-528-35558-6" title="Special:BookSources/978-3-528-35558-6"><bdi>978-3-528-35558-6</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Applied+Pattern+Recognition%3A+Algorithms+and+Implementation+in+C%2B%2B&rft.pub=Springer&rft.date=2003&rft.isbn=978-3-528-35558-6&rft.aulast=W.+R.&rft.aufirst=Dietrich&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> offers viewpoints on proper use of comments in source code. p. 66. </li> <li id="cite_note-Keyes000-8">^ <a href="#cite_ref-Keyes000_8-0">a</a> <a href="#cite_ref-Keyes000_8-1">b</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFKeyes2003" class="citation book cs1">Keyes, Jessica (2003). Software Engineering Handbook. CRC Press. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-0-8493-1479-7" title="Special:BookSources/978-0-8493-1479-7"><bdi>978-0-8493-1479-7</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Software+Engineering+Handbook&rft.pub=CRC+Press&rft.date=2003&rft.isbn=978-0-8493-1479-7&rft.aulast=Keyes&rft.aufirst=Jessica&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> discusses comments and the "Science of Documentation" p. 256. </li> <li id="cite_note-BadComment000-9">^ <a href="#cite_ref-BadComment000_9-0">a</a> <a href="#cite_ref-BadComment000_9-1">b</a> <a href="#cite_ref-BadComment000_9-2">c</a> <a href="/wiki/The_Elements_of_Programming_Style_(book)" class="mw-redirect" title="The Elements of Programming Style (book)">The Elements of Programming Style</a>, <a href="/wiki/Brian_Kernighan" title="Brian Kernighan">Kernighan</a> & <a href="/wiki/P._J._Plauger" title="P. J. Plauger">Plauger</a> </li> <li id="cite_note-GoodComment000-10">^ <a href="#cite_ref-GoodComment000_10-0">a</a> <a href="#cite_ref-GoodComment000_10-1">b</a> <a href="/wiki/Code_Complete" title="Code Complete">Code Complete</a>, <a href="/wiki/Steve_McConnell" title="Steve McConnell">McConnell</a> </li> <li id="cite_note-AlgoComments-11"><a href="#cite_ref-AlgoComments_11-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFSpinellis2003" class="citation book cs1">Spinellis, Diomidis (2003). Code reading: The Open Source Perspective. Addison-Wesley. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-0-201-79940-8" title="Special:BookSources/978-0-201-79940-8"><bdi>978-0-201-79940-8</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Code+reading%3A+The+Open+Source+Perspective&rft.pub=Addison-Wesley&rft.date=2003&rft.isbn=978-0-201-79940-8&rft.aulast=Spinellis&rft.aufirst=Diomidis&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-asciiart000-12"><a href="#cite_ref-asciiart000_12-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://web.archive.org/web/20070714092702/http://www.codeproject.com/macro/codeplotter.asp">"CodePlotter 1.6 – Add and edit diagrams in your code with this 'Visio-like' tool"</a>. Archived from <a rel="nofollow" class="external text" href="http://www.codeproject.com/macro/codeplotter.asp">the original</a> on 2007-07-14. Retrieved 2007-07-24.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=CodePlotter+1.6+%E2%80%93+Add+and+edit+diagrams+in+your+code+with+this+%27Visio-like%27+tool&rft_id=http%3A%2F%2Fwww.codeproject.com%2Fmacro%2Fcodeplotter.asp&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-Niederst000-13">^ <a href="#cite_ref-Niederst000_13-0">a</a> <a href="#cite_ref-Niederst000_13-1">b</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFNiederst2006" class="citation book cs1">Niederst, Jennifer (2006). Web Design in a Nutshell: A Desktop Quick Reference. O'Reilly. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-0-596-00987-8" title="Special:BookSources/978-0-596-00987-8"><bdi>978-0-596-00987-8</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Web+Design+in+a+Nutshell%3A+A+Desktop+Quick+Reference&rft.pub=O%27Reilly&rft.date=2006&rft.isbn=978-0-596-00987-8&rft.aulast=Niederst&rft.aufirst=Jennifer&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988">Sometimes the difference between a "comment" and other syntax elements of a programming or markup language entails subtle nuances. Niederst indicates one such situation by stating: "Unfortunately, XML software thinks of comments as unimportant information and may simply remove the comments from a document before processing it. To avoid this problem, use an XML CDATA section instead." </li> <li id="cite_note-14"><a href="#cite_ref-14">^</a> See e.g., <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFWynne-Powell2008" class="citation book cs1">Wynne-Powell, Rod (2008). <a rel="nofollow" class="external text" href="https://archive.org/details/macosxforphotogr0000wynn">Mac OS X for Photographers: Optimized Image Workflow for the Mac User</a>. Oxford: Focal Press. p. 243. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-0-240-52027-8" title="Special:BookSources/978-0-240-52027-8"><bdi>978-0-240-52027-8</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Mac+OS+X+for+Photographers%3A+Optimized+Image+Workflow+for+the+Mac+User&rft.place=Oxford&rft.pages=243&rft.pub=Focal+Press&rft.date=2008&rft.isbn=978-0-240-52027-8&rft.aulast=Wynne-Powell&rft.aufirst=Rod&rft_id=https%3A%2F%2Farchive.org%2Fdetails%2Fmacosxforphotogr0000wynn&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-15"><a href="#cite_ref-15">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFLamb1998" class="citation book cs1">Lamb, Linda (1998). <a rel="nofollow" class="external text" href="https://archive.org/details/learningvieditor00lamb">Learning the VI Editor</a>. Sebastopol: O'Reilly & Associates. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-1-56592-426-0" title="Special:BookSources/978-1-56592-426-0"><bdi>978-1-56592-426-0</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Learning+the+VI+Editor&rft.place=Sebastopol&rft.pub=O%27Reilly+%26+Associates&rft.date=1998&rft.isbn=978-1-56592-426-0&rft.aulast=Lamb&rft.aufirst=Linda&rft_id=https%3A%2F%2Farchive.org%2Fdetails%2Flearningvieditor00lamb&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> describes the use of modeline syntax in Vim configuration files. </li> <li id="cite_note-16"><a href="#cite_ref-16">^</a> See e.g., <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFBerlin2006" class="citation book cs1">Berlin, Daniel (2006). Practical Subversion, Second Edition. Berkeley: APress. p. 168. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-1-59059-753-8" title="Special:BookSources/978-1-59059-753-8"><bdi>978-1-59059-753-8</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Practical+Subversion%2C+Second+Edition&rft.place=Berkeley&rft.pages=168&rft.pub=APress&rft.date=2006&rft.isbn=978-1-59059-753-8&rft.aulast=Berlin&rft.aufirst=Daniel&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-Ambler000-17"><a href="#cite_ref-Ambler000_17-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFAmbler2004" class="citation book cs1">Ambler, Scott (2004). The Object Primer: Agile Model-Driven Development with UML 2.0. Cambridge University Press. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-1-397-80521-8" title="Special:BookSources/978-1-397-80521-8"><bdi>978-1-397-80521-8</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=The+Object+Primer%3A+Agile+Model-Driven+Development+with+UML+2.0&rft.pub=Cambridge+University+Press&rft.date=2004&rft.isbn=978-1-397-80521-8&rft.aulast=Ambler&rft.aufirst=Scott&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-18"><a href="#cite_ref-18">^</a> <a rel="nofollow" class="external text" href="https://clojure.github.io/clojure/clojure.core-api.html#clojure.core/defn">Function definition with docstring in Clojure</a> </li> <li id="cite_note-19"><a href="#cite_ref-19">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFMurach" class="citation book cs1">Murach. C# 2005. p. 56.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=C%23+2005&rft.pages=56&rft.au=Murach&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-20"><a href="#cite_ref-20">^</a> <a href="https://wiki.c2.com/?HotComments" class="extiw" title="c2:HotComments">c2: HotComments</a> </li> <li id="cite_note-21"><a href="#cite_ref-21">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://docs.ruby-lang.org/en/2.4.0/Encoding.html">"class Encoding"</a>. Ruby. ruby-lang.org. Retrieved 5 December 2018.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Ajournal&rft.genre=unknown&rft.jtitle=Ruby&rft.atitle=class+Encoding&rft_id=https%3A%2F%2Fdocs.ruby-lang.org%2Fen%2F2.4.0%2FEncoding.html&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-22"><a href="#cite_ref-22">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://www.python.org/dev/peps/pep-0263/">"PEP 263 – Defining Python Source Code Encodings"</a>. Python.org. Retrieved 5 December 2018.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=PEP+263+%E2%80%93+Defining+Python+Source+Code+Encodings&rft.pub=Python.org&rft_id=https%3A%2F%2Fwww.python.org%2Fdev%2Fpeps%2Fpep-0263%2F&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-23"><a href="#cite_ref-23">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFPolacek2017" class="citation web cs1">Polacek, Marek (2017-03-10). <a rel="nofollow" class="external text" href="https://developers.redhat.com/blog/2017/03/10/wimplicit-fallthrough-in-gcc-7/">"-Wimplicit-fallthrough in GCC 7"</a>. Red Hat Developer. Red Hat. Retrieved 10 February 2019.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Ajournal&rft.genre=unknown&rft.jtitle=Red+Hat+Developer&rft.atitle=-Wimplicit-fallthrough+in+GCC+7&rft.date=2017-03-10&rft.aulast=Polacek&rft.aufirst=Marek&rft_id=https%3A%2F%2Fdevelopers.redhat.com%2Fblog%2F2017%2F03%2F10%2Fwimplicit-fallthrough-in-gcc-7%2F&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-24"><a href="#cite_ref-24">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFLisa_Eadicicco2014" class="citation web cs1">Lisa Eadicicco (27 March 2014). <a rel="nofollow" class="external text" href="https://www.businessinsider.com/microsoft-hidden-messages-in-word-and-ms-dos-2014-3?r=US&IR=T">"Microsoft Programmers Hid A Bunch Of Profanity In Early Software Code"</a>. <a href="/wiki/Business_Insider_Australia" class="mw-redirect" title="Business Insider Australia">Business Insider Australia</a>. <a rel="nofollow" class="external text" href="https://web.archive.org/web/20161229170544/http://www.businessinsider.com.au/microsoft-hidden-messages-in-word-and-ms-dos-2014-3?r=US&IR=T">Archived</a> from the original on 29 December 2016.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Ajournal&rft.genre=unknown&rft.jtitle=Business+Insider+Australia&rft.atitle=Microsoft+Programmers+Hid+A+Bunch+Of+Profanity+In+Early+Software+Code&rft.date=2014-03-27&rft.au=Lisa+Eadicicco&rft_id=https%3A%2F%2Fwww.businessinsider.com%2Fmicrosoft-hidden-messages-in-word-and-ms-dos-2014-3%3Fr%3DUS%26IR%3DT&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-SwearWords-25"><a href="#cite_ref-SwearWords_25-0">^</a> (see e.g., <a rel="nofollow" class="external text" href="http://www.vidarholen.net/contents/wordcount/">Linux Swear Count</a>). </li> <li id="cite_note-26"><a href="#cite_ref-26">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFGoodliffe2006" class="citation book cs1">Goodliffe, Pete (2006). Code Craft. San Francisco: No Starch Press. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-1-59327-119-0" title="Special:BookSources/978-1-59327-119-0"><bdi>978-1-59327-119-0</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Code+Craft&rft.place=San+Francisco&rft.pub=No+Starch+Press&rft.date=2006&rft.isbn=978-1-59327-119-0&rft.aulast=Goodliffe&rft.aufirst=Pete&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-27"><a href="#cite_ref-27">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFSmith1991" class="citation book cs1">Smith, T. (1991). Intermediate Programming Principles and Techniques Using Pascal. Belmont: West Pub. Co. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-0-314-66314-6" title="Special:BookSources/978-0-314-66314-6"><bdi>978-0-314-66314-6</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Intermediate+Programming+Principles+and+Techniques+Using+Pascal&rft.place=Belmont&rft.pub=West+Pub.+Co&rft.date=1991&rft.isbn=978-0-314-66314-6&rft.aulast=Smith&rft.aufirst=T.&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-28"><a href="#cite_ref-28">^</a> See e.g., <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFKoletzke2000" class="citation book cs1">Koletzke, Peter (2000). Oracle Developer Advanced Forms & Reports. Berkeley: Osborne/McGraw-Hill. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-0-07-212048-6" title="Special:BookSources/978-0-07-212048-6"><bdi>978-0-07-212048-6</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Oracle+Developer+Advanced+Forms+%26+Reports&rft.place=Berkeley&rft.pub=Osborne%2FMcGraw-Hill&rft.date=2000&rft.isbn=978-0-07-212048-6&rft.aulast=Koletzke&rft.aufirst=Peter&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> page 65. </li> <li id="cite_note-BadComments001-29"><a href="#cite_ref-BadComments001_29-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="http://www.sqlservercentral.com/columnists/awarren/worstpracticebadcomments.asp">"Worst Practice - Bad Comments"</a>. Retrieved 2007-07-24.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=Worst+Practice+-+Bad+Comments&rft_id=http%3A%2F%2Fwww.sqlservercentral.com%2Fcolumnists%2Fawarren%2Fworstpracticebadcomments.asp&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-Morelli000-30"><a href="#cite_ref-Morelli000_30-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFMorelli2006" class="citation book cs1">Morelli, Ralph (2006). Java, Java, Java: object-oriented problem solving. Prentice Hall College. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-0-13-147434-5" title="Special:BookSources/978-0-13-147434-5"><bdi>978-0-13-147434-5</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Java%2C+Java%2C+Java%3A+object-oriented+problem+solving&rft.pub=Prentice+Hall+College&rft.date=2006&rft.isbn=978-0-13-147434-5&rft.aulast=Morelli&rft.aufirst=Ralph&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-Javadoc000-31">^ <a href="#cite_ref-Javadoc000_31-0">a</a> <a href="#cite_ref-Javadoc000_31-1">b</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="http://java.sun.com/j2se/javadoc/writingdoccomments/">"How to Write Doc Comments for the Javadoc Tool"</a>. Retrieved 2007-07-24.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=How+to+Write+Doc+Comments+for+the+Javadoc+Tool&rft_id=http%3A%2F%2Fjava.sun.com%2Fj2se%2Fjavadoc%2Fwritingdoccomments%2F&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> Javadoc guidelines specify that comments are crucial to the platform. Further, the appropriate level of detail is fairly well-defined: "We spend time and effort focused on specifying boundary conditions, argument ranges and corner cases rather than defining common programming terms, writing conceptual overviews, and including examples for developers." </li> <li id="cite_note-techniques001-32"><a href="#cite_ref-techniques001_32-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFYourdon2007" class="citation book cs1">Yourdon, Edward (2007). Techniques of Program Structure and Design. University of Michigan. 013901702X.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Techniques+of+Program+Structure+and+Design&rft.pub=University+of+Michigan&rft.date=2007&rft.aulast=Yourdon&rft.aufirst=Edward&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988">Non-existent comments can make it difficult to comprehend code, but comments may be detrimental if they are obsolete, redundant, incorrect or otherwise make it more difficult to comprehend the intended purpose for the source code. </li> <li id="cite_note-CmmtPhilosophy-33"><a href="#cite_ref-CmmtPhilosophy_33-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFDewhurst2002" class="citation book cs1">Dewhurst, Stephen C (2002). C++ Gotchas: Avoiding Common Problems in Coding and Design. Addison-Wesley Professional. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-0-321-12518-7" title="Special:BookSources/978-0-321-12518-7"><bdi>978-0-321-12518-7</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=C%2B%2B+Gotchas%3A+Avoiding+Common+Problems+in+Coding+and+Design&rft.pub=Addison-Wesley+Professional&rft.date=2002&rft.isbn=978-0-321-12518-7&rft.aulast=Dewhurst&rft.aufirst=Stephen+C&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-gnome000-34"><a href="#cite_ref-gnome000_34-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://web.archive.org/web/20070808173421/http://developer.gnome.org/doc/guides/programming-guidelines/code-style.html">"Coding Style"</a>. Archived from <a rel="nofollow" class="external text" href="http://developer.gnome.org/doc/guides/programming-guidelines/code-style.html">the original</a> on 2007-08-08. Retrieved 2007-07-24.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=Coding+Style&rft_id=http%3A%2F%2Fdeveloper.gnome.org%2Fdoc%2Fguides%2Fprogramming-guidelines%2Fcode-style.html&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-Holub000-35"><a href="#cite_ref-Holub000_35-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://web.archive.org/web/20070720153845/http://www.holub.com/company/allen_holub.html">"Allen Holub"</a>. Archived from <a rel="nofollow" class="external text" href="http://www.holub.com/company/allen_holub.html">the original</a> on 2007-07-20. Retrieved 2007-07-24.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=Allen+Holub&rft_id=http%3A%2F%2Fwww.holub.com%2Fcompany%2Fallen_holub.html&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-Holub001-36"><a href="#cite_ref-Holub001_36-0">^</a> Allen Holub, Enough Rope to Shoot Yourself in the Foot, <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/0-07-029689-8" title="Special:BookSources/0-07-029689-8">0-07-029689-8</a>, 1995, McGraw-Hill </li> <li id="cite_note-Thompson1972-37"><a href="#cite_ref-Thompson1972_37-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFKen_Thompson" class="citation web cs1">Ken Thompson. <a rel="nofollow" class="external text" href="https://www.bell-labs.com/usr/dmr/www/kbman.html">"Users' Reference to B"</a>. Retrieved 2017-07-21.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=Users%27+Reference+to+B&rft.au=Ken+Thompson&rft_id=https%3A%2F%2Fwww.bell-labs.com%2Fusr%2Fdmr%2Fwww%2Fkbman.html&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-38"><a href="#cite_ref-38">^</a> <a rel="nofollow" class="external text" href="https://www.python.org/dev/peps/pep-0350/#what-are-codetags">"PEP 0350 – Codetags"</a>, Python Software Foundation </li> <li id="cite_note-39"><a href="#cite_ref-39">^</a> <a rel="nofollow" class="external text" href="https://medium.com/@eido.askayo/never-forget-anything-before-after-and-while-coding-98d187ae4cf1">"Never Forget Anything Before, After and While Coding"</a>, Using "codetag" comments as productive remainders </li> <li id="cite_note-40"><a href="#cite_ref-40">^</a> <a rel="nofollow" class="external text" href="https://msdn.microsoft.com/en-us/library/txtwdysk.aspx#tokenscomments">"Using the Task List"</a>, msdn.microsoft.com </li> <li id="cite_note-41"><a href="#cite_ref-41">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://learningnetwork.cisco.com/thread/71302">"Leave a comment in running-config"</a>. Cisco Learning Network (discussion forum).</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Ajournal&rft.genre=unknown&rft.jtitle=Cisco+Learning+Network+%28discussion+forum%29&rft.atitle=Leave+a+comment+in+running-config&rft_id=https%3A%2F%2Flearningnetwork.cisco.com%2Fthread%2F71302&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-42"><a href="#cite_ref-42">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="GUID-657D5FD4-32C5-444C-BCE0-BC2CC1069005" class="citation web cs1"><a rel="nofollow" class="external text" href="http://www.cisco.com/c/en/us/td/docs/ios-xml/ios/config-mgmt/configuration/xe-3s/asr903/config-mgmt-xe-3s-asr903-book/cm-config-files.html">"Managing Configuration Files Configuration Guide, Cisco IOS XE Release 3S (ASR 900 Series)"</a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=Managing+Configuration+Files+Configuration+Guide%2C+Cisco+IOS+XE+Release+3S+%28ASR+900+Series%29&rft_id=http%3A%2F%2Fwww.cisco.com%2Fc%2Fen%2Fus%2Ftd%2Fdocs%2Fios-xml%2Fios%2Fconfig-mgmt%2Fconfiguration%2Fxe-3s%2Fasr903%2Fconfig-mgmt-xe-3s-asr903-book%2Fcm-config-files.html&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-43"><a href="#cite_ref-43">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="http://www.haskell.org/haskellwiki/Literate_programming#Bird_Style">"Literate programming"</a>. haskell.org.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Ajournal&rft.genre=unknown&rft.jtitle=haskell.org&rft.atitle=Literate+programming&rft_id=http%3A%2F%2Fwww.haskell.org%2Fhaskellwiki%2FLiterate_programming%23Bird_Style&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-44"><a href="#cite_ref-44">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="http://www.lua.org/pil/1.3.html">"Programming in Lua 1.3"</a>. www.Lua.org. Retrieved 2017-11-08.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Ajournal&rft.genre=unknown&rft.jtitle=www.Lua.org&rft.atitle=Programming+in+Lua+1.3&rft_id=http%3A%2F%2Fwww.lua.org%2Fpil%2F1.3.html&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-45"><a href="#cite_ref-45">^</a> <a rel="nofollow" class="external text" href="https://nim-lang.github.io/Nim/macros.html#extractDocCommentsAndRunnables%2CNimNode">macros.extractDocCommentsAndRunnables</a> </li> <li id="cite_note-46"><a href="#cite_ref-46">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFKathleen_Jensen,_Niklaus_Wirth1985" class="citation book cs1">Kathleen Jensen, Niklaus Wirth (1985). Pascal User Manual and Report. Springer-Verlag. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/0-387-96048-1" title="Special:BookSources/0-387-96048-1"><bdi>0-387-96048-1</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Pascal+User+Manual+and+Report&rft.pub=Springer-Verlag&rft.date=1985&rft.isbn=0-387-96048-1&rft.au=Kathleen+Jensen%2C+Niklaus+Wirth&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-47"><a href="#cite_ref-47">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFNiklaus_Wirth1983" class="citation book cs1">Niklaus Wirth (1983). Programming in Modula-2. Springer-Verlag. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/0-387-15078-1" title="Special:BookSources/0-387-15078-1"><bdi>0-387-15078-1</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Programming+in+Modula-2&rft.pub=Springer-Verlag&rft.date=1983&rft.isbn=0-387-15078-1&rft.au=Niklaus+Wirth&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-48"><a href="#cite_ref-48">^</a> *<link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFMartin_Reiser,_Niklaus_Wirth1992" class="citation book cs1">Martin Reiser, Niklaus Wirth (1992). Programming in Oberon. Addison-Wesley. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/0-201-56543-9" title="Special:BookSources/0-201-56543-9"><bdi>0-201-56543-9</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Programming+in+Oberon&rft.pub=Addison-Wesley&rft.date=1992&rft.isbn=0-201-56543-9&rft.au=Martin+Reiser%2C+Niklaus+Wirth&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-49"><a href="#cite_ref-49">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="http://perldoc.perl.org/perlpod.html">"perlpod – the Plain Old Documentation format"</a>. Retrieved 2011-09-12.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=perlpod+%E2%80%93+the+Plain+Old+Documentation+format&rft_id=http%3A%2F%2Fperldoc.perl.org%2Fperlpod.html&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-50"><a href="#cite_ref-50">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://search.cpan.org/~bradapp/PodParser-1.20/lib/Pod/ParseUtils.pm">"Pod::ParseUtils – helpers for POD parsing and conversion"</a>. Retrieved 2011-09-12.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=Pod%3A%3AParseUtils+%E2%80%93+helpers+for+POD+parsing+and+conversion&rft_id=http%3A%2F%2Fsearch.cpan.org%2F~bradapp%2FPodParser-1.20%2Flib%2FPod%2FParseUtils.pm&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-perl6-51">^ <a href="#cite_ref-perl6_51-0">a</a> <a href="#cite_ref-perl6_51-1">b</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://docs.perl6.org/language/syntax#Comments">"Perl 6 Documentation – Syntax (Comments)"</a>. Retrieved 2017-04-06.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=Perl+6+Documentation+%E2%80%93+Syntax+%28Comments%29&rft_id=https%3A%2F%2Fdocs.perl6.org%2Flanguage%2Fsyntax%23Comments&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-triple-52">^ <a href="#cite_ref-triple_52-0">a</a> <a href="#cite_ref-triple_52-1">b</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://web.archive.org/web/20210819164828/https://www.tutorialdocs.com/tutorial/python3/python3-basic-syntax.html">"Python 3 Basic Syntax"</a>. Archived from <a rel="nofollow" class="external text" href="https://www.tutorialdocs.com/tutorial/python3/python3-basic-syntax.html">the original</a> on 19 August 2021. Retrieved 25 February 2019. <q>Triple quotes are treated as regular strings with the exception that they can span multiple lines. By regular strings I mean that if they are not assigned to a variable they will be immediately garbage collected as soon as that code executes. hence are not ignored by the interpreter in the same way that #a comment is.</q></cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=Python+3+Basic+Syntax&rft_id=https%3A%2F%2Fwww.tutorialdocs.com%2Ftutorial%2Fpython3%2Fpython3-basic-syntax.html&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-53"><a href="#cite_ref-53">^</a> <a rel="nofollow" class="external text" href="https://twitter.com/gvanrossum/status/112670605505077248">"Python tip: You can use multi-line strings as multi-line comments"</a>, 11 September 2011, Guido van Rossum </li> <li id="cite_note-MSSQL-54"><a href="#cite_ref-MSSQL_54-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFTalmage1999" class="citation book cs1">Talmage, Ronald R. (1999). <a rel="nofollow" class="external text" href="https://archive.org/details/microsoftsqlserv00talm">Microsoft SQL Server 7</a>. Prima Publishing. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-0-7615-1389-6" title="Special:BookSources/978-0-7615-1389-6"><bdi>978-0-7615-1389-6</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Microsoft+SQL+Server+7&rft.pub=Prima+Publishing&rft.date=1999&rft.isbn=978-0-7615-1389-6&rft.aulast=Talmage&rft.aufirst=Ronald+R.&rft_id=https%3A%2F%2Farchive.org%2Fdetails%2Fmicrosoftsqlserv00talm&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-MySQL-55"><a href="#cite_ref-MySQL_55-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://dev.mysql.com/doc/refman/8.0/en/comments.html">"MySQL 8.0 Reference Manual"</a>. Oracle Corporation. Retrieved January 2, 2020.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=MySQL+8.0+Reference+Manual&rft.pub=Oracle+Corporation&rft_id=https%3A%2F%2Fdev.mysql.com%2Fdoc%2Frefman%2F8.0%2Fen%2Fcomments.html&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-SQLite-56"><a href="#cite_ref-SQLite_56-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://www.sqlite.org/lang_comment.html">"SQL As Understood By SQLite"</a>. SQLite Consortium. Retrieved January 2, 2020.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=SQL+As+Understood+By+SQLite&rft.pub=SQLite+Consortium&rft_id=https%3A%2F%2Fwww.sqlite.org%2Flang_comment.html&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-PostgreSQL-57"><a href="#cite_ref-PostgreSQL_57-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://www.postgresql.org/docs/10/sql-syntax-lexical.html#SQL-SYNTAX-COMMENTS">"PostgreSQL 10.11 Documentation"</a>. The PostgreSQL Global Development Group. Retrieved January 2, 2020.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=PostgreSQL+10.11+Documentation&rft.pub=The+PostgreSQL+Global+Development+Group&rft_id=https%3A%2F%2Fwww.postgresql.org%2Fdocs%2F10%2Fsql-syntax-lexical.html%23SQL-SYNTAX-COMMENTS&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-Oracle-58"><a href="#cite_ref-Oracle_58-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite class="citation web cs1"><a rel="nofollow" class="external text" href="https://docs.oracle.com/cd/B13789_01/server.101/b10759/sql_elements006.htm">"Oracle® Database SQL Reference"</a>. Oracle Corporation. Retrieved January 2, 2020.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=Oracle%C2%AE+Database+SQL+Reference&rft.pub=Oracle+Corporation&rft_id=https%3A%2F%2Fdocs.oracle.com%2Fcd%2FB13789_01%2Fserver.101%2Fb10759%2Fsql_elements006.htm&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> <li id="cite_note-InsecureComments-59"><a href="#cite_ref-InsecureComments_59-0">^</a> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238218222"><cite id="CITEREFAndress2003" class="citation book cs1">Andress, Mandy (2003). Surviving Security: How to Integrate People, Process, and Technology. CRC Press. <a href="/wiki/ISBN_(identifier)" class="mw-redirect" title="ISBN (identifier)">ISBN</a> <a href="/wiki/Special:BookSources/978-0-8493-2042-2" title="Special:BookSources/978-0-8493-2042-2"><bdi>978-0-8493-2042-2</bdi></a>.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Surviving+Security%3A+How+to+Integrate+People%2C+Process%2C+and+Technology&rft.pub=CRC+Press&rft.date=2003&rft.isbn=978-0-8493-2042-2&rft.aulast=Andress&rft.aufirst=Mandy&rfr_id=info%3Asid%2Fen.wikipedia.org%3AComment+%28computer+programming%29" class="Z3988"> </li> </ol></div> <div class="mw-heading mw-heading2"><h2 id="Further_reading">Further reading</h2>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=53" title="Edit section: Further reading">edit</a>]</div> <ul><li>Movshovitz-Attias, Dana and Cohen, William W. (2013) <a rel="nofollow" class="external text" href="https://www.cs.cmu.edu/~dmovshov/papers/dma_acl2013.pdf">Natural Language Models for Predicting Programming Comments</a>. In Association for Computational Linguistics (ACL), 2013.</li></ul> <div class="mw-heading mw-heading2"><h2 id="External_links">External links</h2>[<a href="/w/index.php?title=Comment_(computer_programming)&action=edit&section=54" title="Edit section: External links">edit</a>]</div> <ul><li><a rel="nofollow" class="external text" href="https://web.archive.org/web/20110708033309/http://dkrukovsky.blogspot.com/2005/07/how-to-write-comments.html">How to Write Comments</a> by Denis Krukovsky</li> <li><a rel="nofollow" class="external text" href="https://web.archive.org/web/20070722211609/http://www.ptlogica.com/TwinText/resource/liveuser.pdf">Source Code Documentation as a Live User Manual</a> by PTLogica</li> <li><a rel="nofollow" class="external text" href="https://www.oracle.com/technetwork/java/javase/tech/index-137868.html">How to Write Comments for the Javadoc Tool</a></li></ul>    </div><noscript><img src="https://login.wikimedia.org/wiki/Special:CentralAutoLogin/start?type=1x1" alt="" width="1" height="1" style="border: none; position: absolute;"></noscript> <div class="printfooter" data-nosnippet="">Retrieved from "<a dir="ltr" href="https://en.wikipedia.org/w/index.php?title=Comment_(computer_programming)&oldid=1258397066">https://en.wikipedia.org/w/index.php?title=Comment_(computer_programming)&oldid=1258397066</a>"</div></div> <div id="catlinks" class="catlinks" data-mw="interface"><div id="mw-normal-catlinks" class="mw-normal-catlinks"><a href="/wiki/Help:Category" title="Help:Category">Categories</a>: <ul><li><a href="/wiki/Category:Source_code" title="Category:Source code">Source code</a></li><li><a href="/wiki/Category:Metadata" title="Category:Metadata">Metadata</a></li></ul></div><div id="mw-hidden-catlinks" class="mw-hidden-catlinks mw-hidden-cats-hidden">Hidden categories: <ul><li><a href="/wiki/Category:Articles_with_short_description" title="Category:Articles with short description">Articles with short description</a></li><li><a href="/wiki/Category:Short_description_is_different_from_Wikidata" title="Category:Short description is different from Wikidata">Short description is different from Wikidata</a></li><li><a href="/wiki/Category:Articles_with_example_code" title="Category:Articles with example code">Articles with example code</a></li><li><a href="/wiki/Category:Articles_with_example_C_code" title="Category:Articles with example C code">Articles with example C code</a></li><li><a href="/wiki/Category:Articles_with_example_Java_code" title="Category:Articles with example Java code">Articles with example Java code</a></li><li><a href="/wiki/Category:Articles_with_example_Perl_code" title="Category:Articles with example Perl code">Articles with example Perl code</a></li></ul></div></div> </div> </main> </div> <div class="mw-footer-container"> <footer id="footer" class="mw-footer" > <ul id="footer-info"> <li id="footer-info-lastmod"> This page was last edited on 19 November 2024, at 13:57 (UTC).</li> <li id="footer-info-copyright">Text is available under the <a href="/wiki/Wikipedia:Text_of_the_Creative_Commons_Attribution-ShareAlike_4.0_International_License" title="Wikipedia:Text of the Creative Commons Attribution-ShareAlike 4.0 International License">Creative Commons Attribution-ShareAlike 4.0 License</a>; additional terms may apply. By using this site, you agree to the <a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Terms_of_Use" class="extiw" title="foundation:Special:MyLanguage/Policy:Terms of Use">Terms of Use</a> and <a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Privacy_policy" class="extiw" title="foundation:Special:MyLanguage/Policy:Privacy policy">Privacy Policy</a>. Wikipedia® is a registered trademark of the <a rel="nofollow" class="external text" href="https://wikimediafoundation.org/">Wikimedia Foundation, Inc.</a>, a non-profit organization.</li> </ul> <ul id="footer-places"> <li id="footer-places-privacy"><a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Privacy_policy">Privacy policy</a></li> <li id="footer-places-about"><a href="/wiki/Wikipedia:About">About Wikipedia</a></li> <li id="footer-places-disclaimers"><a href="/wiki/Wikipedia:General_disclaimer">Disclaimers</a></li> <li id="footer-places-contact"><a href="//en.wikipedia.org/wiki/Wikipedia:Contact_us">Contact Wikipedia</a></li> <li id="footer-places-wm-codeofconduct"><a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Universal_Code_of_Conduct">Code of Conduct</a></li> <li id="footer-places-developers"><a href="https://developer.wikimedia.org">Developers</a></li> <li id="footer-places-statslink"><a href="https://stats.wikimedia.org/#/en.wikipedia.org">Statistics</a></li> <li id="footer-places-cookiestatement"><a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Cookie_statement">Cookie statement</a></li> <li id="footer-places-mobileview"><a href="//en.m.wikipedia.org/w/index.php?title=Comment_(computer_programming)&mobileaction=toggle_view_mobile" class="noprint stopMobileRedirectToggle">Mobile view</a></li> </ul> <ul id="footer-icons" class="noprint"> <li id="footer-copyrightico"><a href="https://wikimediafoundation.org/" class="cdx-button cdx-button--fake-button cdx-button--size-large cdx-button--fake-button--enabled"><img src="/static/images/footer/wikimedia-button.svg" width="84" height="29" alt="Wikimedia Foundation" loading="lazy"></a></li> <li id="footer-poweredbyico"><a href="https://www.mediawiki.org/" class="cdx-button cdx-button--fake-button cdx-button--size-large cdx-button--fake-button--enabled"><img src="/w/resources/assets/poweredby_mediawiki.svg" alt="Powered by MediaWiki" width="88" height="31" loading="lazy"></a></li> </ul> </footer> </div> </div> </div> <div class="vector-settings" id="p-dock-bottom"> <ul></ul> </div><script>(RLQ=window.RLQ||[]).push(function(){mw.config.set({"wgHostname":"mw-web.codfw.main-cc877b49b-5pvph","wgBackendResponseTime":250,"wgPageParseReport":{"limitreport":{"cputime":"0.629","walltime":"0.982","ppvisitednodes":{"value":3064,"limit":1000000},"postexpandincludesize":{"value":70420,"limit":2097152},"templateargumentsize":{"value":867,"limit":2097152},"expansiondepth":{"value":16,"limit":100},"expensivefunctioncount":{"value":64,"limit":500},"unstrip-depth":{"value":1,"limit":20},"unstrip-size":{"value":221768,"limit":5000000},"entityaccesscount":{"value":0,"limit":400},"timingprofile":["100.00% 833.502 1 -total"," 42.98% 358.234 1 Template:Reflist"," 24.53% 204.480 26 Template:Cite_book"," 12.90% 107.490 1 Template:Short_description"," 10.74% 89.540 23 Template:Cite_web"," 9.77% 81.412 2 Template:Pagetype"," 2.92% 24.375 1 Template:For"," 1.85% 15.460 1 Template:ISBN"," 1.78% 14.826 4 Template:Main_other"," 1.53% 12.712 1 Template:SDcat"]},"scribunto":{"limitreport-timeusage":{"value":"0.332","limit":"10.000"},"limitreport-memusage":{"value":5695273,"limit":52428800}},"cachereport":{"origin":"mw-api-ext.codfw.main-67468f59cb-mdswh","timestamp":"20241127114331","ttl":2592000,"transientcontent":false}}});});</script> <script type="application/ld+json">{"@context":"https:\/\/schema.org","@type":"Article","name":"Comment (computer programming)","url":"https:\/\/en.wikipedia.org\/wiki\/Comment_(computer_programming)","sameAs":"http:\/\/www.wikidata.org\/entity\/Q1141067","mainEntity":"http:\/\/www.wikidata.org\/entity\/Q1141067","author":{"@type":"Organization","name":"Contributors to Wikimedia projects"},"publisher":{"@type":"Organization","name":"Wikimedia Foundation, Inc.","logo":{"@type":"ImageObject","url":"https:\/\/www.wikimedia.org\/static\/images\/wmf-hor-googpub.png"}},"datePublished":"2006-12-24T14:06:54Z","dateModified":"2024-11-19T13:57:39Z","image":"https:\/\/upload.wikimedia.org\/wikipedia\/commons\/7\/75\/CodeCmmt002.svg","headline":"explanatory note in the source code of a computer program skipped during compilation or interpretation"}</script> </body> </html>