Blooncyclopedia:Hidden comments: Difference between revisions

(One intermediate revision by the same user not shown)

Line 1:

Blooncyclopedia allows editors to insert HTML comments in article text. This is done by inserting <code></code> before and after the text, respectively. This text shows up in both the source editor and visual editor, but not when the page is rendered.

Comments are useful for guiding other editors or ~~altering~~ them to potential mistakes or technical issues that could happen when editing a section, without disrupting the text for readers. Comments should not be used for questions, matters pertaining only to yourself, or matters that don't pertain to wiki editing. ~~Avoid adding too many~~ comments, because they can make editing wiki pages more cumbersome (especially in the visual editor).

Comments are useful for guiding other editors or alerting them to potential mistakes or technical issues that could happen when editing a section, without disrupting the text for readers. Comments should not be used for questions, matters pertaining only to yourself, or matters that don't pertain to wiki editing. It is better to group comments together rather than splitting them up into multiple smaller comments, because they can make editing wiki pages more cumbersome (especially in the visual editor).

==Appropriate uses of comments==

Line 28:

|-

|Personal opinions, editorializing, or other remarks that have nothing to do with wiki editing

|<code></code>

|<code></code><br><code></code>

|-

|Personal reminders

@@ Line 1: / Line 1: @@
 Blooncyclopedia allows editors to insert HTML comments in article text. This is done by inserting <code>&lt;!--</code> and <code>--&gt;</code> before and after the text, respectively. This text shows up in both the source editor and visual editor, but not when the page is rendered.
-Comments are useful for guiding other editors or altering them to potential mistakes or technical issues that could happen when editing a section, without disrupting the text for readers. Comments should not be used for questions, matters pertaining only to yourself, or matters that don't pertain to wiki editing. Avoid adding too many comments, because they can make editing wiki pages more cumbersome (especially in the visual editor).
+Comments are useful for guiding other editors or alerting them to potential mistakes or technical issues that could happen when editing a section, without disrupting the text for readers. Comments should not be used for questions, matters pertaining only to yourself, or matters that don't pertain to wiki editing. It is better to group comments together rather than splitting them up into multiple smaller comments, because they can make editing wiki pages more cumbersome (especially in the visual editor).
 ==Appropriate uses of comments==
@@ Line 28: / Line 28: @@
 |-
 |Personal opinions, editorializing, or other remarks that have nothing to do with wiki editing
-|<code>&lt;!-- This tower sucks --&gt;</code>
+|<code>&lt;!-- This tower sucks --&gt;</code><br><code>&lt;!-- Why won't NK fix this? --&gt;</code>
 |-
 |Personal reminders