<commit_before>#lang scribble/base

@(require "shared.rkt" scribble/eval)

@title{Choosing the Right Construct}

Racket provides a range of constructs for the same or similar purposes.
Although the Racket designers don't think that there is one right way for
everything, we prefer certain constructs in certain situations for consistency
and readability.

@; -----------------------------------------------------------------------------
@section{Comments}

Following Lisp and Scheme tradition, we use a single semicolon for in-line
comments (to the end of a line) and two semicolons for comments that start
a line. Think of the second semicolon as making an emphatic point.

Seasoned Schemers, not necessarily Racketeers, also use triple and
quadruple semicolons. This is considered a courtesy to distinguish file
headers from section headers.

In addition to ``;'', we have two other mechanisms for commenting code:
 ``#|...|#'' for blocks and ``#;'' to comment out an expression.

In rare cases there might be a more substantial piece of text or code, and
 in that case the block comment style can be more convenient than
 semicolons.  Another use of block comments is for code samples to be
 copied and pasted into a file.  Either way, block comments are not used
 for single-line comments.

Expression comments---``#;''---apply to the following S-expression.  This<commit_msg>[Style] explain comments in document<commit_after>#lang scribble/base

@(require "shared.rkt" scribble/eval)

@title{Choosing the Right Construct}

Racket provides a range of constructs for the same or similar purposes.
Although the Racket designers don't think that there is one right way for
everything, we prefer certain constructs in certain situations for consistency
and readability.

@; -----------------------------------------------------------------------------
@section{Comments}

Following Lisp and Scheme tradition, we use a single semicolon for in-line
comments (to the end of a line) and two semicolons for comments that start
a line. @margin-note*{This request does not contradict the programs in this
document. They use two semicolons for full-line comments in source but
scribble renders only one.} Think of the second semicolon as making an
emphatic point.

Seasoned Schemers, not necessarily Racketeers, also use triple and
quadruple semicolons. This is considered a courtesy to distinguish file
headers from section headers.

In addition to ``;'', we have two other mechanisms for commenting code:
 ``#|...|#'' for blocks and ``#;'' to comment out an expression.

In rare cases there might be a more substantial piece of text or code, and
 in that case the block comment style can be more convenient than
 semicolons.  Another use of block comments is for code samples to be
 copied and pasted into a file.  Either way, block comments are not used
 for single-line comments.

Expression comments---``#;''---apply to the following S-expression.  This
{'fraction_non_alphanumeric': 0.10915254237288136, 'fraction_numerical': 0.0, 'mean_word_length': 3.4779969650986344, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4658674', 'n_tokens_mistral': 735, 'n_tokens_neox': 706, 'n_words': 405}