replace: add a --raw mode for --edit
[gitweb.git] / Documentation / CodingGuidelines
index dab5c61bfe4649e603e986d008c66b410038050b..f424dbd75c80abb4d6fecce18f6fc25859bdcb00 100644 (file)
@@ -164,6 +164,16 @@ For C programs:
         * multi-line comment.
         */
 
+   Note however that a comment that explains a translatable string to
+   translators uses a convention of starting with a magic token
+   "TRANSLATORS: " immediately after the opening delimiter, even when
+   it spans multiple lines.  We do not add an asterisk at the beginning
+   of each line, either.  E.g.
+
+       /* TRANSLATORS: here is a comment that explains the string
+          to be translated, that follows immediately after it */
+       _("Here is a translatable string explained by the above.");
+
  - Double negation is often harder to understand than no negation
    at all.