i18n: mention "TRANSLATORS:" marker in Documentation/CodingGuidelines
These comments have to have "TRANSLATORS: " at the very beginning and have to deviate from the usual multi-line comment formatting convention. Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
Apr 18, 2014 at 10:48 UTC
cbcfd4e3ea9db3125619591b942f56d0a8f3ef48
1 file changed
+10
Documentation/CodingGuidelines
+10
@@ -164,6 +164,16 @@ For C programs:
164
* multi-line comment.
165
*/
166
167
+ Note however that a comment that explains a translatable string to
168
+ translators uses a convention of starting with a magic token
169
+ "TRANSLATORS: " immediately after the opening delimiter, even when
170
+ it spans multiple lines. We do not add an asterisk at the beginning
171
+ of each line, either. E.g.
172
+
173
+ /* TRANSLATORS: here is a comment that explains the string
174
+ to be translated, that follows immediately after it */
175
+ _("Here is a translatable string explained by the above.");
176
+
177
- Double negation is often harder to understand than no negation
178
at all.
179