INI Comments

Like any other file extensions, Comments are allowed,

Inline comments are allowed Block comments are not supported Comments format represents in two formats

One is using the Semicolon symbol ; placed at beginning of each line followed by comment text. Another way to use the hash symbol # for key and value pair comments. hashing syntax only supports some of the implementations and space after the # symbol is recommended.

Important rules

  • Comments must prefix semicolon followed by space
  • Comments must be single line only and closed

Here is a syntax

; comments text

# key= value

Comments text are not processed or interpreted by programming languages.

Ini file comments example

It is included in package.json as follows.

; this is the beginning of the ini file
; empty lines are ignored
; Inline comments example
key1=value1
# keycomment=example