Kód

Použijte <code> pro vložený kód a <pre class="prettyprint"> pro bloky kódu. Zvýraznění syntaxe funguje dobře pro mnoho jazyků, včetně příkladů XML a HTML. Můžete vynechat class="prettyprint" pokud zvýraznění syntaxe není pro tento příklad vhodné, například pro příkazy konzoly nebo dlouhé adresy URL koncových bodů služby.

Nepřekračujte 100 znaků kódu na řádek v bloku <pre> . V DevSite se přesně 100 znaků kódu vejde na větší obrazovky, než se spustí horizontální posouvání. Na menších obrazovkách se bloky kódu budou v případě potřeby posouvat vodorovně. 80 znaků se vejde prakticky 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>

Pro příkazy konzole byste obvykle vynechali class="prettyprint" z <pre> . Například:

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

Kliknutím zkopírujte

Na všech blocích kódu s třídou prettyprint se automaticky zobrazí tlačítko pro kopírování kliknutím.

Chcete-li použít kopírování kliknutím na blok kódu nebo jiný prvek, který nemá třídu prettyprint , přidejte třídu 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ázání kopírování kliknutím na blok kódu

Chcete-li zakázat kopírování kliknutím na blok kódu prettyprint , přidejte třídu 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>

Chcete-li u bloku kódu Markdown zakázat kopírování kliknutím, použijte při otevření ochrany kódu pro použití stylu devsite-disable-click-to-copy následující syntaxi:

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

Zakázání kopírování kliknutím na část bloku kódu

Chcete-li zabránit kopírování části bloku kódu, přidejte kolem části, kterou nechcete kopírovat, značku <span> s třídou no-select :

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

V níže uvedeném příkladu ignoruje jak ruční kopírování, tak tlačítko kopírování kliknutím anotovanou část:

C:\\> ping google.com

Analytické události zkopírované kliknutím

Chcete-li odlišit analytické události kopírování kliknutím, nastavte atribut data-copy-event-label .

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

Kopírování kliknutím a dostupnost

Ve výchozím nastavení mají všechny ukázky kódu s možností kopírování stejný štítek pro každé tlačítko kopírování: „Kopírovat ukázku kódu“. Na stránkách s více ukázkami kódu to může ztížit navigaci pomocí čtečky obrazovky.

Pro usnadnění poskytněte každému ukázkovému kódu ke kopírování atribut data-label , který stručně a výstižně označí obsah každého ukázkového kódu. Každý štítek ukázky kódu by měl být jedinečný vzhledem ke všem ostatním ukázkovým štítkům kódu na stránce; tento štítek čtou čtečky obrazovky kromě „Kopírovat ukázku kódu“. {:.devsite-click-to-copy} <pre class="devsite-click-to-copy" data-label="Installation script"></pre>

Vypnutí přepínače světlo/tma

Chcete-li deaktivovat tlačítko pro přepínání světla/tmy na bloku kódu, přidejte třídu devsite-disable-code-toggle :

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

Chcete-li deaktivovat tlačítko přepínání světlý/tmavý na bloku kódu Markdown , použijte při otevření ohrazení kódu k použití třídy devsite-disable-code-toggle následující syntaxi:

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

Ve výchozím nastavení tmavý kód

Chcete-li, aby blok kódu ve výchozím nastavení používal tmavý styl kódu, přidejte třídu devsite-dark-code-default :

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

Vynucené zalomení čáry

Ve výchozím nastavení je pro řádky v bloku <pre> , které přesahují 100 znaků, přidán vodorovný posuvník.

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)

Chcete-li toto chování přepsat a místo toho zalomit řádky, přidejte do bloku <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)

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

Při předvádění kódu pro terminál doporučujeme autorům použít $ k označení nového příkazu terminálu. Chcete-li přidat $ na začátek obsahu kontejneru <pre> , aniž byste jej přidali do zkopírovaného kódu uživatele, použijte na prvek <pre> class="devsite-terminal" .

adb devices

Kód:

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

Chcete-li přidat $ na začátek jednoho řádku kódu terminálu, použijte class="devsite-terminal" na prvek <code> obsahující tento řádek. Tuto taktiku použijte pro případy s $ ve více řádcích.

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

Chcete-li použít vlastní předponu, přidejte atribut data-terminal-prefix do prvku <pre> nebo <code> , kde byla třída použita.

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šechny instance předpony přidané pomocí třídy „devsite-terminal“ budou vyloučeny z kódu zkopírovaného uživatelem.

Zvýraznění

Pomocí <strong> můžete upozornit na obsah v bloku <pre> . Pokud tak učiníte, zesvětlí okolní obsah, aby se zdůraznila část zvýrazněná blokem <strong> . Napří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>

Vyměnitelné proměnné

Použijte <var> a velká písmena s podtržítky pro nahraditelný text v <pre> . Například:

dev_appserver.py YOUR_APP_DIR.

Kód:

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

V Markdown uzavřete značky <var> do uvozovek a pomocí závorek výrazu Jinja uzavřete značky takto: VAR_NAME .

Například:

Hello, my name is YOUR_NAME.

Kód:

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

Snížení

Bloky kódu můžete také určit pomocí Markdown s odsazením kódu o 4 mezery nebo jeho ohrazením pomocí 3 zpětných znamének (```).

Například:

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

oba se stávají

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

Pokud používáte chráněné bloky kódu (a ne odsazené bloky kódu), můžete také určit jazyk pro prettyprint, abyste mu rozuměli:

print("hello world")

se stává

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

Seznam uznávaných jazyků naleznete v dokumentaci Prettify .

Všechny bloky kódu vytvořené prostřednictvím Markdown budou mít třídu prettyprint, pokud jazyk výslovně nenastavíte na žádný. Do bloku kódu můžete přidat další třídy pomocí vlastních atributů :

The program completed successfully.

se stává

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