kód

Použite <code> pre vložený kód a <pre class="prettyprint"> pre bloky kódu. Zvýraznenie syntaxe funguje dobre pre mnoho jazykov vrátane príkladov XML a HTML. Môžete vynechať class="prettyprint" ak zvýraznenie syntaxe nie je vhodné pre daný príklad, napríklad pre príkazy konzoly alebo dlhé adresy URL koncových bodov služby.

Neprekračujte 100 znakov kódu na riadok v bloku <pre> . V DevSite sa na väčšie obrazovky zmestí presne 100 znakov kódu, kým sa spustí horizontálne posúvanie. Na menších obrazovkách sa bloky kódu budú v prípade potreby posúvať horizontálne. 80 znakov sa zmestí takmer na každý notebook.

#include <stdio.h>

/* Counting example */
int main(int argc, char** argv) {
    int i;

    // This counts from 0 to 9.
    for (i = 0; i < 10; i++) {
        printf("Counting %d\n", i);
    }
}
<pre class="prettyprint">
#include <stdio.h>

/* Counting example */
int main(int argc, char** argv) {
    int i;

    // This counts from 0 to 9.
    for (i = 0; i < 10; i++) {
        printf("Counting %d\n", i);
    }
}
</pre>

Pre príkazy konzoly by ste zvyčajne vynechali class="prettyprint" z <pre> . Napríklad:

dev_appserver.py -a $HOST --debug demos/getstarted
<pre>dev_appserver.py -a $HOST --debug demos/getstarted</pre>

Klikni a skopíruj

Na všetkých blokoch kódu s triedou prettyprint sa automaticky zobrazí tlačidlo kopírovania kliknutím.

Ak chcete použiť kopírovanie kliknutím na blok kódu alebo iný prvok, ktorý nemá triedu prettyprint , pridajte triedu devsite-click-to-copy : some_terminal_command.py --users_should_copy <pre class="devsite-click-to-copy">some_terminal_command.py --users_should_copy</pre>

Zakázanie kopírovania kliknutím na blok kódu

Ak chcete zakázať kopírovanie kliknutím na blok kódu prettyprint , pridajte triedu devsite-disable-click-to-copy :

www.example-url-that-does-not-make-sense-to-copy.com
<pre class="prettyprint devsite-disable-click-to-copy">www.example-url-that-does-not-make-sense-to-copy.com</pre>

Ak chcete zakázať kopírovanie kliknutím v bloku kódu Markdown , pri otvorení ochrany kódu na použitie štýlu devsite-disable-click-to-copy použite nasledujúcu syntax:

{:.devsite-disable-click-to-copy}

Zakázanie kopírovania kliknutím na časť bloku kódu

Ak chcete zabrániť kopírovaniu časti bloku kódu, pridajte okolo časti, ktorú nechcete kopírovať, značku <span> s triedou no-select :

<span class="no-select">C:\> </span>ping google.com

V nižšie uvedenom príklade manuálne kopírovanie, ako aj tlačidlo kopírovania kliknutím ignorujú časť s poznámkami:

C:\\> ping google.com

Udalosti analýzy skopírujte kliknutím

Ak chcete odlíšiť udalosti analýzy typu click-to-copy, nastavte atribút data-copy-event-label .

data-copy-event-label
<pre class="devsite-terminal devsite-click-to-copy" data-copy-event-label="unique_identifier"></pre>

Kopírovanie kliknutím a dostupnosť

V predvolenom nastavení majú všetky vzorky kódu s možnosťou kopírovania kliknutím rovnaké označenie pre každé tlačidlo kopírovania: „Kopírovať vzorku kódu“. Na stránkach s viacerými vzorkami kódu to môže sťažiť navigáciu pomocou čítačky obrazovky.

Kvôli zjednodušeniu poskytnite každej vzorke kódu na kopírovanie kliknutím atribút data-label , ktorý stručne a výstižne označuje obsah každej vzorky kódu. Každé označenie vzorky kódu by malo byť jedinečné vzhľadom na všetky ostatné označenia vzorky kódu na stránke; tento štítok čítajú čítačky obrazovky okrem „Kopírovať ukážku kódu“. {:.devsite-click-to-copy} <pre class="devsite-click-to-copy" data-label="Installation script"></pre>

Vypnutie prepínača svetlo/tma

Ak chcete vypnúť tlačidlo prepínania svetla/tmy na bloku kódu, pridajte triedu devsite-disable-code-toggle :

<pre class="prettyprint devsite-disable-code-toggle"></pre>

Ak chcete zakázať tlačidlo prepínania svetla a tmy na bloku kódu Markdown , pri otvorení ohradenia kódu na použitie triedy devsite-disable-code-toggle použite nasledujúcu syntax:

``` {.devsite-disable-code-toggle}

V predvolenom nastavení tmavý kód

Ak chcete, aby blok kódu používal predvolene tmavý štýl kódu, pridajte triedu devsite-dark-code-default :

<pre class="prettyprint devsite-dark-code-default"></pre>

Vynútené ovíjanie čiary

V predvolenom nastavení sa pre riadky v bloku <pre> , ktoré presahujú 100 znakov, pridá vodorovný posúvač.

run(dataset: google.cloud.aiplatform.datasets.time_series_dataset.TimeSeriesDataset, target_column: str, time_column: str, time_series_identifier_column: str, unavailable_at_forecast_columns: List[str], available_at_forecast_columns: List[str], forecast_horizon: int, data_granularity_unit: str, data_granularity_count: int, training_fraction_split: Optional[float] = None, validation_fraction_split: Optional[float] = None, test_fraction_split: Optional[float] = None, predefined_split_column_name: Optional[str] = None, weight_column: Optional[str] = None, time_series_attribute_columns: Optional[List[str]] = None, context_window: Optional[int] = None, export_evaluated_data_items: bool = False, export_evaluated_data_items_bigquery_destination_uri: Optional[str] = None, export_evaluated_data_items_override_destination: bool = False, quantiles: Optional[List[float]] = None, validation_options: Optional[str] = None, budget_milli_node_hours: int = 1000, model_display_name: Optional[str] = None, model_labels: Optional[Dict[str, str]] = None, sync: bool = True)

Ak chcete toto správanie prepísať a namiesto toho zalomiť riadky, pridajte class="wrap-code" do bloku <pre> .

run(dataset: google.cloud.aiplatform.datasets.time_series_dataset.TimeSeriesDataset, target_column: str, time_column: str, time_series_identifier_column: str, unavailable_at_forecast_columns: List[str], available_at_forecast_columns: List[str], forecast_horizon: int, data_granularity_unit: str, data_granularity_count: int, training_fraction_split: Optional[float] = None, validation_fraction_split: Optional[float] = None, test_fraction_split: Optional[float] = None, predefined_split_column_name: Optional[str] = None, weight_column: Optional[str] = None, time_series_attribute_columns: Optional[List[str]] = None, context_window: Optional[int] = None, export_evaluated_data_items: bool = False, export_evaluated_data_items_bigquery_destination_uri: Optional[str] = None, export_evaluated_data_items_override_destination: bool = False, quantiles: Optional[List[float]] = None, validation_options: Optional[str] = None, budget_milli_node_hours: int = 1000, model_display_name: Optional[str] = None, model_labels: Optional[Dict[str, str]] = None, sync: bool = True)

kód:

<pre class="wrap-code">
run(dataset: google.cloud.aiplatform.datasets.time_series_dataset.TimeSeriesDataset, target_column: str, time_column: str, time_series_identifier_column: str, unavailable_at_forecast_columns: List[str], available_at_forecast_columns: List[str], forecast_horizon: int, data_granularity_unit: str, data_granularity_count: int, training_fraction_split: Optional[float] = None, validation_fraction_split: Optional[float] = None, test_fraction_split: Optional[float] = None, predefined_split_column_name: Optional[str] = None, weight_column: Optional[str] = None, time_series_attribute_columns: Optional[List[str]] = None, context_window: Optional[int] = None, export_evaluated_data_items: bool = False, export_evaluated_data_items_bigquery_destination_uri: Optional[str] = None, export_evaluated_data_items_override_destination: bool = False, quantiles: Optional[List[float]] = None, validation_options: Optional[str] = None, budget_milli_node_hours: int = 1000, model_display_name: Optional[str] = None, model_labels: Optional[Dict[str, str]] = None, sync: bool = True)
</pre>

Kód terminálu

Pri demonštrácii kódu pre terminál odporúčame autorom použiť $ na označenie nového príkazu terminálu. Ak chcete pridať $ na začiatok obsahu kontajnera <pre> bez toho, aby ste ho pridali do skopírovaného kódu používateľa, použite class="devsite-terminal" na prvok <pre> .

adb devices

kód:

<pre class="devsite-terminal devsite-click-to-copy">
adb devices
</pre>

Ak chcete pridať $ na začiatok jedného riadku kódu terminálu, použite class="devsite-terminal" na prvok <code> obsahujúci tento riadok. Túto taktiku použite pre prípady s $ vo viacerých riadkoch.

gradle init --type basic
mkdir -p src/main/java src/main/resources

kód:

<pre class="prettyprint">
<code class="devsite-terminal">gradle init --type basic</code>
<code class="devsite-terminal">mkdir -p src/main/java src/main/resources</code>
</pre

Ak chcete použiť vlastnú predponu, pridajte atribút data-terminal-prefix do prvku <pre> alebo <code> , kde bola trieda použitá.

Install-Package Google.Apis.Calendar.v3

kód:

<pre class="devsite-terminal devsite-click-to-copy" data-terminal-prefix="PM&gt; ">
Install-Package Google.Apis.Calendar.v3
</pre>

Všetky inštancie predpony pridané pomocou triedy „devsite-terminal“ budú vylúčené zo skopírovaného kódu používateľa.

Zvýraznenie

Pomocou <strong> môžete upozorniť na obsah v rámci bloku <pre> . Ak tak urobíte, zosvetlí sa okolitý obsah, aby sa zvýraznila časť zvýraznená blokom <strong> . Napríklad:

// ...
// ...
// ...
for (i = 0; i < 10; i++) {
    printf("Counting %d\n", i);

    if (i % 3 == 0) {
        someFunc(i);
    }
}
// ...
// ...
// ...

kód:

<pre class="prettyprint">
// ...
// ...
// ...
for (i = 0; i < 10; i++) {
    printf("Counting %d\n", i);

    <strong>if (i % 3 == 0) {
        someFunc(i);
    }</strong>
}
// ...
// ...
// ...
</pre>

Vymeniteľné premenné

Použite <var> a veľké písmená s podčiarkovníkom pre vymeniteľný text v rámci <pre> . Napríklad:

dev_appserver.py YOUR_APP_DIR.

kód:

<pre>dev_appserver.py <var>YOUR_APP_DIR</var></pre>

V Markdown uzatvorte značky <var> do úvodzoviek a použite zátvorky výrazu Jinja na ukončenie značiek, napríklad takto: VAR_NAME .

Napríklad:

Hello, my name is YOUR_NAME.

kód:

    ```
    Hello, my name is YOUR_NAME.
    ```

Markdown

Môžete tiež určiť bloky kódu pomocou Markdown s odsadením kódu so 4 medzerami alebo jeho ohradením pomocou 3 backticks (```).

Napríklad:

    ```
    print("hello world")
    ```
    print("hello world")

obaja sa stávajú

<pre class="prettyprint notranslate" translate="no"><code>
print("hello world")
</code></pre>

Ak používate ohradené bloky kódu (a nie odsadené bloky kódu), môžete tiež určiť jazyk pre prettyprint, aby ste mu porozumeli:

print("hello world")

sa stáva

<pre class="prettyprint notranslate lang-py" translate="no"><code>
print("hello world")
</code></pre>

Zoznam rozpoznaných jazykov nájdete v dokumentácii Prettify .

Všetky bloky kódu vytvorené prostredníctvom Markdown budú mať aplikovanú triedu prettyprint, pokiaľ jazyk nie je explicitne nastavený na žiadny. Do bloku kódu môžete pridať ďalšie triedy pomocou vlastných atribútov :

The program completed successfully.

sa stáva

<pre class="devsite-disable-click-to-copy"><code>The program completed successfully.
</code></pre>