View source for Zho:注释 (编程功能)

{{:Eng:Comment (programming feature)/translate}}
{{April Fools}}{{Featured|October|2017}}{{about|the kind of comment attachable to a [[script]]|the kind of comment seen on the website|Comment (website feature)}}
'''Comments''' in the [[Scratch|Scratch program]] are adjustable textboxes that can be attached to [[blocks]], or left floating. The comment boxes can be adjusted both horizontally and vertically, dragged around the [[Scripts Area]], and deleted. In a survey conducted by the [[Scratch Team]], which tried to identify the top scripts used by Scratchers, the comment block (which was accidentally found by the survey engine due to technical reasons) ranked 10th, is 0.68% of all scripts on the website.
==History==
[[File:The old comment block.png|frame|The old comment block from the Scratch 1.2 beta. It can still be found in old Scratch [[project]]s that used the block.]]The Scratch 1.2 beta introduced a comment block as a [[Control Blocks|Control block]] that could be placed inside a script as one of its blocks. It made no change to the script, as it only held text {{-}} however, newer [[Scratcher|users]] grew confused about it, causing it to be removed in the official Scratch 1.2 release.

The offline player will treat the comment block as an obsolete block, and as such, stop the script that contains the comment. This can be a problem for old projects that contain the comment block.

Both the Scratch Team and the Scratch community wanted the ability to add comments to scripts in order to improve their readability. [[Scratch 1.3]] introduced the modern comments that are still used today. Since [[Scratch 1.4]], comments can be stuck to a block so that comments remain attached when a script is dragged around. The font used with the comment block, also used in drop-down menus, was changed to Verdana with Scratch 1.3.

== Adding Comments ==
[[File:Right click dropdown.png|right|thumb|The right click menu for a block.]][[File:Comment.png|frame|The new comment from [[Scratch 2.0]]]]To add a comment to a block, right-click it, and in the drop-down menu choose "add comment". This will add a yellow box in which you can type your comment. Comments can be added anywhere in the Scripts Area the same way.

==Use==
A main use for comments is to explain how a script is working. An example is below:
==== 简体中文 ====
<scratchblocks>
点击绿旗时
造型换成 [costume1 v] //  Preparing the project...
变量 [variable v] 设为 [0]
定位到 x: (0) y: (0)
重复无限次 
  如果 <碰到颜色 [#372080] ?> 那么 
    变量 [variable v] 改变 (1)
  end
  如果 <碰到颜色 [#00bb03] ?> 那么 
    变量 [variable v] 改变 (-1)
  end
end
</scratchblocks>
==== 繁體中文 ====
<scratchblocks>
當 @greenFlag 被點擊
造型換成 [costume1 v] // Preparing the project...
變數 [variable v] 設為 [0]
定位到 x: (0) y: (0)
重複無限次 
  如果 <碰到顏色 [#372080] ?> 那麼 
    變數 [variable v] 改變 (1)
  end // Gameplay.
  如果 <碰到顏色 [#00bb03] ?> 那麼 
    變數 [variable v] 改變 (-1)
  end
end
</scratchblocks>

{{Note|The comments are attached to the blocks with a line a pixel thick, theoretically making it hard to see on this wiki or anywhere else with a white background.}}

Another purpose of the comment feature is to provide some hidden info the user wishes to not share in the [[Notes and Credits]].<ref>https://scratch.mit.edu/projects/26693568/</ref>

==Shapes==
[[File:The two comment types.png|frame|The two comment types. The top one is a mini comment and the bottom one is a full comment.]]Comments can be shaped in two ways {{-}} a full comment or a mini comment. The type can be changed by clicking the gray triangle at the upper-left of a comment.

In 2.0, comments are created by right-clicking. If you right-click on a block, the comment will be connected by a (very) thin line to that block. If you right-click on the stage, the comment will not be connected to anything. You can edit or delete a comment by right-clicking on it. 

Mini comments are one line long and hold the amount of characters that will fit on one width of the comment. Change from Mini to Full by clicking the triangle at the top left of the comment. Full comments display all text entered into it, which can extend infinitely. 

The width (size) of comments can be altered by clicking (the parallel lines at) the bottom right-hand corner of the comment and dragging to the desired width (size). This can also be extended infinitely and is particularly useful if the mini comment is too narrow to display a sufficient amount of characters.

==Blocks Plugin==
To use comments in the [[Block Plugin|blocks plugin]], simply add "//" after the block to be commented, and add the annotation after that. This syntax is derived from comments in most high-level languages. Comments in the Block Plugin look like:

<pre>move (10) steps // This is a comment attached to a block.</pre>
<scratchblocks>move (10) steps // This is a comment attached to a block.</scratchblocks>
<pre>//Stray comment</pre>
<scratchblocks>//Stray comment</scratchblocks>

==References==
<references/>
[[Category:Scratch Program]]
[[de:Kommentar (Projekt)]]
[[ja:コメント (プログラム)]]