注释 (计算机语言)

维基百科,自由的百科全书
跳转至: 导航搜索
Confusion grey.svg
提示:本条目的主题不是腳注

计算机语言中,注释是计算机语言的一个重要组成部分,可以增强程序的可读性,可维护性。

使用[编辑]

代码描述[编辑]

算法描述[编辑]

比如,下面程序将增加一个注释来解释为什么插入排序没有被快速排序所替代,即使理论上前者比后者更慢。这将写为如下:

 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);

资源包含[编辑]

调试[编辑]

调试过程中增加注释。

自动文档生成[编辑]

一些开发工具通过注释来生成文档。
java程序通过javadoc, c/c++等通过doxygen生成文档。

种类与格式[编辑]

注释可分类为:

  • 风格(行/块)
  • 解释规则(忽略/插入/内存存储)
  • 递归(支持/不支持)

行注释[编辑]

行注释通过使用换行'\n'字符来指示注释结束, 以及使用标记来开始一条注释。 例:

符号 语言
C Fortran 77; 'C'必须在一行的第一个字符。
REM BASIC, COMMAND.COM
# bash, CobraPerlPythonRubyWindows PowerShellPHPMaple
% TeX, Prolog, MATLAB[1], Erlang, S-LangVisual Prolog</references/>
{} Pascal
// ActionScriptC99C++C#Go, Object Pascal(Delphi),JavaJavaScriptPHP
' Visual BasicVBScriptRealBasic
! Fortran, Basic Plus
; AutoHotkeyAutoitLispScheme, many assemblers
-- EuphoriaHaskellSQLAdaApplescriptEiffelLuaVHDL
* COBOL, many assemblers
|| Curl
" Vim脚本
\ Forth
:: 批处理[2]

块注释[编辑]

块注释通过定义一个注释开始和一个注释结束标记来使用。在上下文中,空格換行字符不作为区分标志。 例:

符号 语言
¢ ~ ¢, # ~ #, co ~ co, comment ~ comment ALGOL 68
/* */ ActionScript, AutoHotkey, C, C++, C#, Go, Java, JavaScript, PHP, PL/I, SQL, Visual Prolog, CSS
/# #/ Cobra
""" """ Python, Ruby[3]
''' ''' Python[3]
=begin =cut Perl
=begin =end Ruby
#<tag> #</tag> S-Lang
{- -} Haskell
(* *) Object Pascal(Delphi),ML, Mathematica, Pascal, Applescript, OCaml, Maple
{ } Object Pascal(Delphi),Pascal
<!-- --> HTMLXML
|# #| Curl
%{ %} MATLAB[4]
#| |# Lisp
--[[ ]] Lua

参考资料[编辑]