Manual:Coding conventions/zh

本页描述了MediaWiki代码库及扩展内的代码编写约定，用于维基媒体网站，包含适当的命名常规. 不符合这些约定的代码可能会被代码检查者投负票，这应该视为请求修复风格问题和更新补丁.

本页列举了所有MediaWiki代码的一般约定，无论语言写在何处. 有关适用于MediaWiki中特定组件或文件类型的指南，请参阅：



在wikitech（至少应用于operations/puppet）：


 * Puppet

缩进大小
各行应使用每级缩进用一个制表符缩进. 不应该对每个制表符的空格数做任何假设. 大多数MediaWiki开发人员发现每个制表符4个空格宽最可读，但许多系统配置为每个制表符使用8个空格，一些开发人员可能每个制表符使用2个空格.

对于vim用于，一种进行设置的方式是在$HOME/.vimrc中添加如下内容：

autocmd Filetype php setlocal ts=4 sw=4

对CSS、HTML、JavaScript也有类似行

然而，对于Python，应该遵循PEP 8的空白字符指引，新项目推荐空格.

新行
所有文件都应该使用Unix样式的换行符（单个LF字符，而不是CR+LF组合）.


 * Windows上的git在提交时，会默认自动将CR+LF换行符转化成LF.

所有文件末尾都应该有个换行.


 * 这样做因为所有其他行的末尾都有换行符.
 * 这样使以非二进制格式（如差异）传递数据更容易.
 * 命令行工具，如cat和wc，处理文件时，如果没有末尾换行，就可能出现问题（或者至少，不是按照应该或者预期的样式处理）.

编码
所有文本文件必须编码为不带字节顺序标记的zh:UTF-8格式.

不要使用Microsoft记事本编辑文件，因为总是会加入BOM. BOM阻止PHP文件工作，因为是文件顶部的特殊字符，并将由网页浏览器输出到客户端.

简而言之，确保你的编辑器支持不带BOM的UTF-8.

尾随空白字符
使用IDE时，按Home和End键（以及其他键盘快捷键）通常会忽略尾随空格，按照预期跳转到代码的末尾. 但是，在非IDE文本编辑器中，按End将跳转到行尾，这意味着开发人员必须把尾随空格删掉才能到达他们实际想要输入的位置.

在大多数文本编辑器中，删除尾随空格是项琐碎的操作. 开发人员应避免添加尾随空格，主要是在包含其他可见代码的行上.

一些工具可以方便完成：


 * nano: GNU nano 3.2;
 * ：在“Edit > Preferences”的Save Options中，启用“Clean trailing whitespace and EOL markers”和“Only clean changed lines”.
 * Kate：可以启用“Highlight trailing spaces”选项来查看尾随空格，该选项位于“Settings > Configure Kate > Appearance”中. 你还可以在“Settings > Configure Kate > Open/Save”中告诉Kate清理尾随空格.
 * vim：各种自动清理插件；
 * Sublime Text：TrailingSpaces插件.

关键字
非必要不使用带关键字的括号（如 、 ）.

一般规则
MediaWiki的缩进格式类似于“One True Brace Style”. 大括号与函数、条件、循环等的开头放在同一行. else/elseif与前一个右大括号放在同一行.

多行语句是在第二行和后续行缩进一级的情况下编写的：

使用缩进与折行澄清你的代码逻辑结构. 嵌套多级括号或类似结构的表达式，可能会在每级嵌套中新增一级缩进：

垂直对齐
避免垂直对齐. 垂直对齐往往会产生难以解释的差异，因为项目越来越多后，左列容留的宽度也得不断增加.

When needed, create mid-line vertical alignment with spaces rather than tabs. For instance this:

Is achieved as follows with spaces rendered as dots:

 $namespaceNames·=·[ → NS_MEDIA············=>·'Media', → NS_SPECIAL··········=>·'Special', → NS_MAIN·············=>·'', ];

(If you use the tabular vim add-on, entering :Tabularize /= will align the '=' signs.)

续行
Lines should be broken at between 80 and 100 columns. There are some rare exceptions to this. Functions which take lots of parameters are not exceptions.

The operator separating the two lines should be placed consistently (always at the end or always at the start of the line). Individual languages might have more specific rules.

The method operator should always be put at the beginning of the next line.

When continuing "if" statements, a switch to Allman-style braces makes the separation between the condition and the body clear:

Opinions differ on the amount of indentation that should be used for the conditional part. Using an amount of indentation different to that used by the body makes it more clear that the conditional part is not the body, but this is not universally observed.

Continuation of conditionals and very long expressions tend to be ugly whichever way you do them. So it's sometimes best to break them up by means of temporary variables.

Braceless control structures
Do not write "blocks" as a single-line. They reduce the readability of the code by moving important statements away from the left margin, where the reader is looking for them. Remember that making code shorter doesn't make it simpler. The goal of coding style is to communicate effectively with humans, not to fit computer-readable text into a small space.

This avoids a common logic error, which is especially prevalent when the developer is using a text editor which does not have a "smart indenting" feature. The error occurs when a single-line block is later extended to two lines:

Later changed to:

This has the potential to create subtle bugs.

emacs风格
In emacs, using  from nXHTML mode, you can set up a MediaWiki minor mode in your   file:

The above  function will check your path when   is invoked to see if it contains “mw” or “mediawiki” and set the buffer to use the   minor mode for editing MediaWiki source. You will know that the buffer is using  because you'll see something like “PHP MW” or “PHP/lw MW” in the mode line.

构建URL
Never build URLs manually with string concatenation or similar. Always use the full URL format for requests made by your code (especially POST and background requests).

You can use the appropriate or  method in PHP, the  magic word in wikitext, the mw.util.getUrl method in JavaScript, and similar methods in other languages. You'll avoid issues with unexpected short URL configuration and more.

文件命名
Files which contain server-side code should be named in UpperCamelCase. This is also our naming convention for extensions. Name the file after the most important class it contains; most files will contain only one class, or a base class and a number of descendants. For example,  contains only the   class;   contains the   class, and also its descendants   and.

接入点文件
Name "access point" files, such as SQL, and PHP entry points such as  and , in lowercase. Maintenance scripts are generally in lowerCamelCase, although this varies somewhat. Files intended for the site administrator, such as readmes, licenses and changelogs, are usually in UPPERCASE.

Never include spaces in file names or directories, and never use non-ASCII characters. For lowercase titles, hyphens are preferred to underscores.

JS、CSS和媒体文件
For JavaScript, CSS and other frontend files (usually registered via ResourceLoader) should be placed in directory named after the module bundle in which they are registered. For example, module  might have files   and

JavaScript files that define classes should match exactly the name of the class they define. The class  should be in a file named as, or ending with,. This allows for rapid navigation in text editors by navigating to files named after a selected class name (such as "Goto Anything [P]" in Sublime, or "Find File [P]" in Atom).

Large projects may have classes in a hierarchy with names that would overlap or be ambiguous without some additional way of organizing files. We generally approach this with subdirectories like  (for Package files), or longer class and file names like   in.

Modules bundles registered by extensions should follow names like, for example. This makes it easy to get started with working on a module in a text editor, by directly finding the source code files from only the public module name (T193826).

文档
The language-specific subpages have more information on the exact syntax for code comments in files, e.g. comments in PHP for doxygen. Using precise syntax allows us to generate documentation from source code at doc.wikimedia.org.

High level concepts, subsystems, and data flows should be documented in the  folder.

源文件头
In order to be compliant with most licenses you should have something similar to the following (specific to GPLv2 PHP applications) at the top of every source file.

许可证
Licenses are generally referred to by their full name or acronym as per SPDX standard. See also Manual:$wgExtensionCredits#license.

动态标识符
It is generally recommended to avoid dynamically constructing identifiers such as interface message keys, CSS class names, or file names. When possible, write them out and select between them (e.g. using a conditional, ternary, or switch). This improves code stabilty and developer productivity through: easier code review, higher confidence during debugging, usage discovery, git-grep, Codesearch, etc.

If code is considered to be a better reflection of the logical structure, or if required to be fully variable, then you may concatenate the identifier with a variable instead. In that case, you must leave a comment nearby with the possible (or most common) values to demonstrate behaviour and to aid search and discovery.

参见：
 * Help:System message

发行说明
You must document all significant changes (including all fixed bug reports) to the core software which might affect wiki users, server administrators, or extension authors in the  file. is in development; on every release we move the past release notes into the  file and start afresh. is generally divided into three sections:


 * Configuration changes is the place to put changes to accepted default behavior, backwards-incompatible changes, or other things which need a server administrator to look at and decide "is this change right for my wiki?". Try to include a brief explanation of how the previous functionality can be recovered if desired.
 * Bug fixes is the place to note changes which fix behavior which is accepted to be problematic or undesirable. These will often be issues reported in Phabricator, but needn't necessarily.
 * New features is, unsurprisingly, to note the addition of new functionality.

There may be additional sections for specific components (e.g. the Action API) or for miscellaneous changes that don't fall into one of the above categories.

In all cases, if your change is in response to one or more issues reported in Phabricator, include the task ID(s) at the start of the entry. Add new entries in chronological order at the end of the section.

系统消息
When creating a new system message, use hyphens (-) where possible instead of CamelCase or snake_case. So for example,  is a good name, while   and   are not.

If the message is going to be used as a label which can have a colon after it, don't hardcode the colon; instead, put the colon inside the message text. Some languages (such as French which require a space before) need to handle colons in a different way, which is impossible if the colon is hardcoded. The same holds for several other types of interpunctuation.

Try to use message keys "whole" in code, rather than building them on the fly; as this makes it easier to search for them in the codebase. For instance, the following shows how a search for  will not find this use of the message key if they are not used as a whole.

If you feel that you have to build messages on the fly, put a comment with all possible whole messages nearby:

See Localisation for more conventions about creating, using, documenting and maintaining message keys.

推荐的拼写
It is just as important to have consistent spelling in the UI and codebase as it is to have consistent UI. By long standing history, 'American English' is the preferred spelling for English language messages, comments, and documentation.

消息键中的简写

 * ph
 * 占位符（输入字段中的文本）


 * tip
 * 提示文本


 * tog-xx
 * toggle options in user preferences

标点
Non-title error messages are considered as sentences and should have punctuation.

改进内核
If you need some additional functionality from a MediaWiki core component (PHP class, JS module etc.), or you need a function that does something similar but slightly different, prefer to improve the core component. Avoid duplicating the code to an extension or elsewhere in core and modifying it there.

重构
Refactor code as changes are made: don't let the code keep getting worse with each change.

However, use separate commits if the refactoring is large. See also Architecture guidelines (draft).

HTML
MediaWiki HTTP responses output HTML that can be generated by one of two sources. The MediaWiki PHP code is a trusted source for the user interface, it can output any arbitrary HTML. The Parser converts user-generated wikitext into HTML, this is an untrusted source. Complex HTML created by users via wikitext is often found in the "Template" namespace. HTML produced by the Parser is subject to sanitization before output.

Most data attributes are allowed to be used by users in wikitext and templates. But, the following prefixes have been restricted and are not allowed in wikitext. This enables client JavaScript code to determine whether a DOM element came from a trusted source:


 * – This attribute is present in HTML generated by OOUI widgets.
 * – reserved attribute for internal use by Parsoid.
 * and  – reserved attribute for internal use by MediaWiki core, skins and extensions. The   is also used by Parsoid.

When selecting elements in JavaScript, one can specify an attribute key/value to ensure only DOM elements from the intended trusted source are considered. Example: Only trigger 'wikipage.diff' hook for official diffs.

外部链接

 * Code style tools