幫助:代碼高亮工具

這個頁面「Help:代碼高亮工具」是萌娘百科的小工具說明文檔

• 本文是站點小工具的詳細使用說明，簡要介紹請參閱Special:小工具；
• 本文僅是一篇幫助文檔，若有任何疑問，請至萌娘百科_talk:討論版/技術實現提問。

Code prettify是一個基於JavaScript開發的頁面顯示工具，可以對頁面上的代碼進行高亮。您可以在參數設置中勾選「代碼高亮工具^DM 閱讀時高亮顯示頁面上的代碼塊。」啟用此工具。

此工具基於Google Code Prettify寫成，源地址：https://github.com/googlearchive/code-prettify

可用語言列表

自動高亮語言

本工具支持下表左列語言的高亮和自動檢測，探測到對應語言的代碼塊時會自動進行高亮。

語言支持情況

受支持的語言	對應可用名稱
TypeScript	ts typescript
JavaScript	js javascript
JSON	json
CSS	css
HTML	htm html
Lua	scribunto lua
PHP	php
Regex	regex
LaTeX	latex tex

手動高亮語言

本工具支持code-prettify默認支持的其他語言高亮，但不會自動檢測語言，需要手動指定語言：

• C系列語言：c, cc, cpp, cxx, cyc, cs
• Java
• Python
• Bash
• SQL
• Perl
• XML
• Ruby
• Makefile
• Rust
• 正則表達式

不在上表的語言也可能能被高亮，但效果不作保證。

使用方法

讀者側

您只需要到參數設置中勾選「代碼高亮工具^DM 閱讀時高亮顯示頁面上的代碼塊。」啟用本工具即可。

編輯側

您可以通過以下幾種方式編寫可被本工具自動檢測語言並高亮的代碼塊：

1. JS、CSS頁面等頁面內容模型為#自動高亮語言表中左側語言之一的頁面；
2. 在<pre>、<code>標籤里填寫lang屬性，值需為#自動高亮語言表中右側名稱之一，不分大小寫：
   • {{pre}}支持<pre>的語言指定，具體參見模板文檔。

您可以通過以下方式編寫可被本工具高亮的代碼塊，但須手動指定語言：

3. 在<pre>、<code>標籤里填寫class屬性，值需為prettyprint lang-【语言名】，語言名要麼為MediaWiki:Gadget-code-prettify-core.js#L681-L739所定義的語言名，要麼為該語言的通用名或文件擴展名，不分大小寫。

通過上述第2、3種方法進行高亮的<pre>元素可在標籤里填寫data-start屬性，值需為正整數，指定代碼第一行的行號，若不指定則默認為1。