Перейти к содержанию

Справка:Исходный код

Материал из Хабадпедии
Редактирование статей

Руководства по редактированию

Добавление элементов на страницу:

Другое:

Эта страница объясняет, как можно оформлять и отображать исходный код программ.

Тег syntaxhighlight (или source)

Использование тегов syntaxhighlight особенно удобно при отображении исходного кода на различных компьютерных языках. Ниже — способ использования:

<syntaxhighlight lang="text">

Текст

</syntaxhighlight>

При этом слово «текст» можно заменить обозначением языка. Например:

Вики-код Результат
<syntaxhighlight lang="csharp">
// Hello World program in Microsoft C#

using System;
class HelloWorld
{
    public static int Main(String[] args)
    {
        Console.WriteLine("Hello, World!");
        return 0;
    }
}
</syntaxhighlight>
// Hello World program in Microsoft C#

using System;
class HelloWorld
{
    public static int Main(String[] args)
    {
        Console.WriteLine("Hello, World!");
        return 0;
    }
}


Список поддерживаемых языков

Языки программирования

  • ActionScript
  • Ada
  • ANTLR
  • AppleScript
  • Assembly
  • Asymptote
  • Awk
  • Befunge
  • Boo
  • BrainFuck
  • C / C++
  • C#
  • Clojure
  • CoffeeScript
  • ColdFusion
  • Common Lisp
  • Coq
  • Cryptol
  • Crystal
  • Cython
  • D
  • Dart
  • Delphi
  • Dylan
  • Elm
  • Erlang
  • Ezhil
  • Factor
  • Fancy
  • Fortran
  • F#
  • GAP
  • Gherkin (Cucumber)
  • GL shaders
  • Groovy
  • Haskell
  • IDL
  • Io
  • Java
  • JavaScript
  • Lasso
  • LLVM
  • Logtalk
  • Lua
  • Matlab
  • MiniD
  • Modelica
  • Modula-2
  • MuPad
  • Nemerle
  • Nimrod
  • Objective-C
  • Objective-J
  • Octave
  • OCaml
  • PHP
  • Perl
  • PovRay
  • PostScript
  • PowerShell
  • Prolog
  • Python 2.x and 3.x
  • REBOL
  • Red
  • Redcode
  • Ruby
  • Rust
  • S, S-Plus and R
  • Scala
  • Scheme
  • Scilab
  • Smalltalk
  • SNOBOL
  • Tcl
  • Vala
  • Verilog
  • VHDL
  • Visual Basic.NET
  • Visual FoxPro
  • XQuery
  • Zephir

Языки шаблонов

  • Cheetah templates
  • Django / Jinja templates
  • ERB
  • Genshi
  • JSP
  • Myghty
  • Mako
  • Smarty templates
  • Tea

Другие виды разметки

  • Apache config files
  • Bash shell scripts
  • BBCode
  • CMake
  • CSS
  • Debian control files
  • Diff files
  • DTD
  • Gettext catalogs
  • Gnuplot script
  • Groff markup
  • HTML
  • HTTP sessions
  • INI-style config files
  • IRC logs (irssi style)
  • Lighttpd config files
  • Makefiles
  • MoinMoin/Trac Wiki markup
  • MySQL
  • Nginx config files
  • POV-Ray scenes
  • Ragel
  • Redcode
  • ReST
  • Robot Framework
  • RPM spec files
  • SQL
  • Squid configuration
  • TeX
  • tcsh
  • Vim Script
  • Windows batch files
  • XML
  • XSLT
  • YAML

Замечания

  • Если используется несуществующий язык или отсутствует параметр lang, страница будет автоматически отнесена к Категория:Страницы с ошибками подсветки кода.
  • Тег <syntaxhighlight> вошёл в употребление недавно. До сих пор так же использовался тег <source>, но он выходит из употребления, поскольку </source> подсветки кода легко спутать с таким же тегом внутри кода, например на языке html.
  • Подсветку можно добавить с помощью кнопки Оформление кода.
  • Язык вики не поддерживается. Если текст включает теги (например, <div>), можно использовать язык html, в противном случае рекомендуется использовать язык text.

Оформление тегов syntaxhighlight

Помимо параметра lang, использованного выше, у тегов syntaxhighlight есть ещё несколько параметров:

  • Параметр line: добавление параметра (без значения) добавляет номер к каждой строке. Например,
Вики-код Результат
<syntaxhighlight lang="csharp" line>
class HelloWorld
{
    public static int Main(String[] args)
    {
        Console.WriteLine("Hello, World!");
        return 0;
    }
}
</syntaxhighlight>
class HelloWorld
{
    public static int Main(String[] args)
    {
        Console.WriteLine("Hello, World!");
        return 0;
    }
}
  • Параметр start: при использовании параметра line выше можно использовать также параметр start для указания номера первой строки. Например, можно начать нумерацию с цифры 6, и следующие строки будут 7, 8 и так далее.
  • Параметр highlight: выделение одной строки из всего кода. Например, передача цифры «4» в этом параметре добавит оранжевое выделение четвёртой строке (независимо от номера, заданного в параметре start).
Вики-код Результат
<syntaxhighlight lang="csharp" line start=33 highlight="1,4,8">
class HelloWorld
{
    public static int Main(String[] args)
    {
        Console.WriteLine("Hello, World!");
        return 0;
    }
}
</syntaxhighlight>
class HelloWorld
{
    public static int Main(String[] args)
    {
        Console.WriteLine("Hello, World!");
        return 0;
    }
}
  • Параметр inline позволяет встроить код внутрь текста. Например, код <syntaxhighlight lang=java inline>return a.b[35] + 114</syntaxhighlight> встроит текст return a.b[35] + 114 внутрь строки. В таком случае параметр line не будет работать, а параметр highlight помешает корректной вставке внутрь строки. Стоит рассмотреть использование параметра |class=nowrap, например <syntaxhighlight lang=java inline class=nowrap>return a.b[35] + 114</syntaxhighlight>. Это предотвратит разрыв кода на две строки, если не хватает места, и в таком случае начнёт сразу с новой строки.
  • Можно добавлять обычные параметры языка html, например style или class (см. пример в предыдущем разделе).

Теги code

Когда возникает необходимость отобразить исходный код в теле текста (а не на новой строке), желательно выделить код и отличить его от самого текста. Это можно сделать с помощью тегов code. Ниже — способ использования:

<code>текст</code>

Сама вышеприведённая строка заключена в теги кода, и можно заметить изменение шрифта и сероватый фон.

Теги code можно сочетать с тегами nowiki, когда возникает необходимость отобразить вики-код. Например, код

"Можно добавлять ссылки на статьи следующим образом: <code><nowiki>[[קישור]]</nowiki></code>".

даст следующий результат:

"Можно добавлять ссылки на статьи следующим образом: [[קישור]]".

Обратите внимание, что теги nowiki — внутренние, а снаружи от них находятся теги code.

См. также
Альтернатива тегам code: шаблон {{קוד}}

Внешние ссылки

Сообщить об ошибке на этой странице