代碼著色之SyntaxHighlighter項(xiàng)目(最流行的代碼高亮)

更新時(shí)間：2014年04月29日 22:15:11 作者：

dp.SyntaxHighlighter。它可以在網(wǎng)頁(yè)中對(duì)各種程序源代碼語(yǔ)法進(jìn)行加亮顯示。支持當(dāng)前流行的各種編程語(yǔ)言：C#、CSS、C++、Delphi、Java、JavaScript、PHP、Python、Ruby、SQL、Visual Basic、XML / HTML等

下載地址：http://www.dreamprojections.com/syntaxhighlighter/
或http://code.google.com/p/syntaxhighlighter/
演示地址：http://www.dreamprojections.com/syntaxhighlighter/Tests/PHP.html

使用方法：

1、假設(shè)網(wǎng)頁(yè)文件test.htm存放在一個(gè)目錄，則將dp.SyntaxHighlighter解壓縮到該目錄下的子目錄，假設(shè)為images
2、在網(wǎng)頁(yè)的<head></head>之間插入以下代碼：

3、在網(wǎng)頁(yè)要顯示程序源代碼的地方插入以下代碼（其中的class="js"表示以js語(yǔ)法顯示源代碼，其他可設(shè)定的class值分別為c#、css、c、delphi、java、js、php、python、ruby、sql、vb、xml）：

復(fù)制代碼代碼如下:

<textarea name="code" class="js" rows="15" cols="100">
程序源代碼放在這兒
</textarea> 

4、在網(wǎng)頁(yè)尾部的</body>之前插入以下代碼：

復(fù)制代碼代碼如下:

<html>
<head>
<title>測(cè)試</title>
<link type="text/css" rel="stylesheet" href="Styles/SyntaxHighlighter.css"></link>
</head>
<body>
<textarea name="code" class="java" rows="15" cols="100">
public class a{
}
</textarea>
</body>
<script class="javascript" src="Scripts/shCore.js"></script>
<script class="javascript" src="Scripts/shBrushCSharp.js"></script>
<script class="javascript" src="Scripts/shBrushPhp.js"></script>
<script class="javascript" src="Scripts/shBrushJScript.js"></script>
<script class="javascript" src="Scripts/shBrushJava.js"></script>
<script class="javascript" src="Scripts/shBrushVb.js"></script>
<script class="javascript" src="Scripts/shBrushSql.js"></script>
<script class="javascript" src="Scripts/shBrushXml.js"></script>
<script class="javascript" src="Scripts/shBrushDelphi.js"></script>
<script class="javascript" src="Scripts/shBrushPython.js"></script>
<script class="javascript" src="Scripts/shBrushRuby.js"></script>
<script class="javascript" src="Scripts/shBrushCss.js"></script>
<script class="javascript" src="Scripts/shBrushCpp.js"></script>
<script class="javascript">
dp.SyntaxHighlighter.ClipboardSwf ='Scripts/clipboard.swf';
dp.SyntaxHighlighter.HighlightAll('code');
</script>  
</html>

SyntaxHighlighter 是Google Code 上的一個(gè)開源項(xiàng)目，主要用于給網(wǎng)頁(yè)上的代碼著色，使用十分方便，效果也不錯(cuò)，而且?guī)缀踔С殖Ｒ?jiàn)的所有語(yǔ)言。

安裝使用方法：

1. 首先在頁(yè)面上添加如下代碼（假設(shè)下載后的SyntaxHighlighter放在SyntaxHighlighter目錄下面，注意目錄結(jié)構(gòu)）：

復(fù)制代碼代碼如下:

<link type="text/css" rel="stylesheet" href="SyntaxHighlighter/Styles/SyntaxHighlighter.css"></link>
<script language="javascript" src="SyntaxHighlighter/Scripts/shCore.js"></script>
<script language="javascript" src="SyntaxHighlighter/Scripts/shBrushCSharp.js"></script>
<script language="javascript" src="SyntaxHighlighter/Scripts/shBrushXml.js"></script>
<script language="javascript">
window.onload = function () 
{
    dp.SyntaxHighlighter.ClipboardSwf = 'SyntaxHighlighter/Scripts/clipboard.swf';
    dp.SyntaxHighlighter.HighlightAll('code');
}
</script>

官方的安裝中沒(méi)有window.onload，我想這個(gè)還是需要的，畢竟，頁(yè)面加載的時(shí)候我就需要給代碼著色。

2. 使用方法如下：

方法一：使用pre

復(fù)制代碼代碼如下:

<pre name="code" class="c-sharp">
... some code here ... 
</pre>

方法二：使用textarea

復(fù)制代碼代碼如下:

<textarea name="code" class="c#" cols="60" rows="10"> 
... some code here ... 
</textarea>

另外，這里還有一些高級(jí)特性的設(shè)置方法可供參考，諸如代碼折疊等。

我在互動(dòng)wiki 上安裝成功，安裝方法如上，第一步的修改代碼放到doc.php文件的最后即可，以后編輯wiki的時(shí)候直接使用html模式即可按照第二步的方法給代碼著色。

PS：CSDN的blog系統(tǒng)上使用的也是這個(gè)插件:>

=============================
http://code.google.com/p/syntaxhighlighter/downloads/list

第一步：增加樣式包含

復(fù)制代碼代碼如下:

<textarea name=”code” class=”php”>
代碼放在這里
</textarea>

這里的class指的是語(yǔ)言有c,c#,vb,java,php,ruby,js,css,sql…

第三步包含所需要的js

復(fù)制代碼代碼如下:

<script language=”javascript” src=”Scripts/shCore.js”></script>
<script language=”javascript” src=”Scripts/shBrushPhp.js”></script>(包含對(duì)應(yīng)語(yǔ)言的文件)
<script language=”javascript”>
dp.SyntaxHighlighter.ClipboardSwf = ‘Scripts/clipboard.swf';// 復(fù)制代碼要用到
dp.SyntaxHighlighter.HighlightAll('code');// 這里對(duì)應(yīng)的就是上面的name
</script>

====================================

1.首先下載SyntaxHighlighter.

2.解壓到SyntaxHighlighter目錄中.

3.建立HTML文件:

復(fù)制代碼代碼如下:

<pre name="code" class="Ruby">
...Ruby代碼...
</pre>

可以應(yīng)用在pre和textarea兩種HTML標(biāo)簽內(nèi),name為code,class為要著色的語(yǔ)言,現(xiàn)在支持C, C#, CSS, Delphi, Java, JScript, Php, Python, Ruby, Sql, VB, XML這些語(yǔ)言.

4.加入所需的CSS和JS文件:

復(fù)制代碼代碼如下:

<link rel="stylesheet" type="text/css" href="./lib/SyntaxHighlighter/Styles/SyntaxHighlighter.css" />
<script src="./lib/SyntaxHighlighter/Scripts/shCore.js"></script>
<script src="./lib/SyntaxHighlighter/Scripts/shBrushRuby.js"></script>

這里只用了Ruby,其他的類似.

5.接下來(lái)就是在window的onload事件內(nèi),讓SyntaxHighlighter工作起來(lái).

復(fù)制代碼代碼如下:

window.onload = function()

{
dp.SyntaxHighlighter.ClipboardSwf = './lib/SyntaxHighlighter/Scripts/clipboard.swf';
dp.SyntaxHighlighter.HighlightAll("code");
};

之后,刷新下頁(yè)面,你就會(huì)發(fā)現(xiàn),代碼已經(jīng)被著上了相應(yīng)的顏色了

======================
將你要高亮顯示的代碼放在 pre 或 textarea 中

復(fù)制代碼代碼如下:

<pre name="code" class="c-sharp">
... some code here ...
</pre>
<textarea name="code" class="c#" cols="60" rows="10">
... some code here ...
</textarea>

class選項(xiàng)允許你單獨(dú)配置文本塊。

nogutter 將不會(huì)顯示行號(hào)。

nocontrols     將不會(huì)在頂部顯示控制器。
collapse     將默認(rèn)折疊代碼。
firstline[value]     行計(jì)數(shù)開始值。默認(rèn)值是 1
showcolumns     將在第一行顯示行列。

這些選項(xiàng)和別名放置在一起，使用冒號(hào) : 字符分隔。

復(fù)制代碼代碼如下:

... some code here ...
</pre>

語(yǔ)言別名

C++     cpp, c, c++
C#     c#, c-sharp, csharp
CSS     css
Delphi     delphi, pascal
Java     java
Java Script     js, jscript, javascript
PHP     php
Python     py, python
Ruby     rb, ruby, rails, ror
Sql     sql
VB     vb, vb.net
XML/HTML     xml, html, xhtml, xslt

在頁(yè)面最后添加JS和CSS引用 JS有很多，若是語(yǔ)言固定的話，只要引入 shCore 和 shBrushXml(相應(yīng)) 的JS文件就行了

復(fù)制代碼代碼如下:

<link type="text/css" rel="stylesheet" href="css/SyntaxHighlighter.css"></link>
<script language="javascript" src="js/shCore.js"></script>
<script language="javascript" src="js/shBrushCSharp.js"></script>
<script language="javascript" src="js/shBrushXml.js"></script>
<script language="javascript">
dp.SyntaxHighlighter.ClipboardSwf = '/flash/clipboard.swf';
dp.SyntaxHighlighter.HighlightAll('code');//這里的 ‘code' 為上面放置代碼的容器
</script>

* SyntaxHighlighter－HighlightAll 方法

這是一個(gè)全局函數(shù)，它找出網(wǎng)頁(yè)上所有的代碼塊，將他們轉(zhuǎn)換成高亮的代碼塊。
參數(shù)
function dp.SyntaxHighlighter.HighlightAll(name, [showGutter], [showControls],
[collapseAll], [firstLine], [showColumns])

name 必要 <pre> 和 <textarea> 元素使用的名稱。

showGutter     可選     打開或關(guān)閉所有處理的代碼塊的行號(hào)。（默認(rèn)為 true）
showControls     可選     打開或關(guān)閉所有處理的 <pre> 的控制器。（默認(rèn)為 true）
collapseAll     可選     打開或關(guān)閉所有處理的 <pre> 的折疊。如果 showControls 是 false 或被交換了，這個(gè)值將被忽略。（默認(rèn)為 false）
firstLine     可選     允許指定行號(hào)開始的第一行。當(dāng)你想指明代碼塊在文件的哪個(gè)相對(duì)位置時(shí)有用。（默認(rèn)為 1）
showColumns     可選     將在第一行顯示行列。（默認(rèn)為 false）

所有傳到 HighlightAll 調(diào)用的值將重載配置的對(duì)應(yīng)選項(xiàng).

下載地址：

http://code.google.com/p/syntaxhighlighter/

附一個(gè)小例子說(shuō)一下 textarea 和 pre 的區(qū)別

復(fù)制代碼代碼如下:

<html>
<head>
<title>高亮測(cè)試</title>
    <link type="text/css" rel="stylesheet" href="Styles/SyntaxHighlighter.css"/>
    <script language="javascript" src="Scripts/shCore.js"></script>
    <script language="javascript" src="Scripts/shBrushXml.js"></script>
</head>
<body>
<textarea name="code" class="xml" rows="15" cols="100">
程序源代碼放在這兒afds
dp.SyntaxHighlighter.HighlightAll('code');
dp.SyntaxHighlighter.HighlightAll('code2');
請(qǐng)注譯掉這二句查看效果,注意 textarea 和 pre 的分別。pre中的 《 號(hào)需要轉(zhuǎn)譯，要不然就原樣輸出了,在高亮代碼沒(méi)有生效的情況下。
<h1>adsfadfadf</h1>
    -------------------
&lt;h1>adsfadfadf&lt;/h1>
</textarea> 
<pre name="code2" class="xml" rows="15" cols="100">
程序源代碼放在這兒afds
dp.SyntaxHighlighter.HighlightAll('code');
dp.SyntaxHighlighter.HighlightAll('code2');
    <h1>adsfadfadf</h1>
    -------------------
&lt;h1>adsfadfadf&lt;/h1>
</pre> 
<script class="javascript">
dp.SyntaxHighlighter.HighlightAll('code');
dp.SyntaxHighlighter.HighlightAll('code2');
</script>
</body>
</html>