Izmantojiet <code>
iekļautajam kodam un <pre class="prettyprint">
kodu blokiem. Sintakses izcelšana labi darbojas daudzās valodās, tostarp XML un HTML piemēros. Varat izlaist class="prettyprint"
ja sintakses izcelšana šim piemēram nav piemērota, piemēram, konsoles komandām vai gariem pakalpojuma galapunkta URL.
Nepārsniedziet 100 koda rakstzīmes vienā rindā <pre>
blokā. Vietnē DevSite uz lielākiem ekrāniem ietilps tieši 100 koda rakstzīmes, pirms sāksies horizontālā ritināšana. Mazākos ekrānos koda bloki vajadzības gadījumā ritinās horizontāli. 80 rakstzīmes var ietilpt gandrīz jebkurā klēpjdatorā.
#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>
Parasti jūs izlaižat class="prettyprint"
no <pre>
konsoles komandām. Piemēram:
dev_appserver.py -a $HOST --debug demos/getstarted
<pre>dev_appserver.py -a $HOST --debug demos/getstarted</pre>
Noklikšķiniet, lai kopētu
Poga Noklikšķināt, lai kopētu, automātiski parādās visos kodu blokos ar klasi prettyprint
.
Lai izmantotu “noklikšķināt, lai kopētu” koda blokā vai citā elementā, kuram nav klases prettyprint
, pievienojiet klasi 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>
Noklikšķināt, lai kopētu koda blokā, tiek atspējota funkcija
Lai atspējotu noklikšķināt, lai kopētu prettyprint
koda blokā, pievienojiet klasi 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>
Lai Markdown koda blokā atspējotu noklikšķināt, lai kopētu, izmantojiet šādu sintaksi, kad atverat koda nožogojumu, lai lietotu stilu devsite-disable-click-to-copy
:
{:.devsite-disable-click-to-copy}
Koda bloka daļas “noklikšķināt, lai kopētu” atspējošana
Lai novērstu koda bloka daļas kopēšanu, pievienojiet tagu <span>
ar no-select
klasi ap to daļu, kuru nevēlaties kopēt:
<span class="no-select">C:\> </span>ping google.com
Tālāk esošajā piemērā gan manuālā kopēšana, gan poga “noklikšķināt, lai kopētu” ignorē anotēto daļu:
C:\\> ping google.com
Noklikšķināt, lai kopētu analīzes notikumus
Lai atdalītu analītikas notikumus “noklikšķināt, lai kopētu”, iestatiet atribūtu data-copy-event-label
.
data-copy-event-label
<pre class="devsite-terminal devsite-click-to-copy" data-copy-event-label="unique_identifier"></pre>
Noklikšķināt, lai kopētu, un pieejamība
Pēc noklusējuma visiem “noklikšķināt, lai kopētu” koda paraugiem katrai pogai “noklikšķināt, lai kopētu” ir vienāda etiķete: “Kopēt koda paraugu”. Lapās ar vairākiem koda paraugiem tas var apgrūtināt navigāciju ar ekrāna lasītāju.
Pieejamības nodrošināšanai nodrošiniet katram koda paraugam “noklikšķināt, lai kopētu” ar data-label
atribūtu, kas īsi un kodolīgi iezīmē katra koda parauga saturu. Katrai koda parauga etiķetei ir jābūt unikālai attiecībā pret visām pārējām koda parauga etiķetēm lapā; šo iezīmi nolasa ekrāna lasītāji papildus "Kopēt koda paraugu". {:.devsite-click-to-copy} <pre class="devsite-click-to-copy" data-label="Installation script"></pre>
Gaismas/tumsas pārslēgšanas atspējošana
Lai koda blokā atspējotu gaismas/tumšās pārslēgšanas pogu, pievienojiet klasi devsite-disable-code-toggle
:
<pre class="prettyprint devsite-disable-code-toggle"></pre>
Lai Markdown koda blokā atspējotu gaismas/tumšās pārslēgšanas pogu, atverot koda nožogojumu, izmantojiet šādu sintaksi, lai lietotu devsite-disable-code-toggle
klasi:
``` {.devsite-disable-code-toggle}
Pēc noklusējuma tumšs kods
Lai koda blokā pēc noklusējuma izmantotu tumšā koda stilu, pievienojiet klasi devsite-dark-code-default
:
<pre class="prettyprint devsite-dark-code-default"></pre>
Spēka līnijas aptīšana
Pēc noklusējuma rindiņām <pre>
blokā, kas pārsniedz 100 rakstzīmes, tiek pievienota horizontāla ritjosla.
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)
Lai ignorētu šo darbību un tā vietā aplauztu rindas, pievienojiet <pre>
blokam 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)
Kods:
<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>
Termināļa kods
Demonstrējot termināļa kodu, autoriem iesakām izmantot $
, lai norādītu jaunu termināļa komandu. Lai pievienotu $
<pre>
konteinera satura sākumam, nepievienojot to lietotāja kopētajam kodam, elementam <pre>
lietojiet class="devsite-terminal"
.
adb devices
Kods:
<pre class="devsite-terminal devsite-click-to-copy">
adb devices
</pre>
Lai vienas termināļa koda rindas sākumā pievienotu $
, izmantojiet class="devsite-terminal"
elementam <code>
, kas satur šo rindiņu. Izmantojiet šo taktiku gadījumos, kad $
ir vairākās rindās.
gradle init --type basic
mkdir -p src/main/java src/main/resources
Kods:
<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
Lai izmantotu pielāgotu prefiksu, pievienojiet atribūtu data-terminal-prefix
elementam <pre>
vai <code>
, kurā tika lietota klase.
Install-Package Google.Apis.Calendar.v3
Kods:
<pre class="devsite-terminal devsite-click-to-copy" data-terminal-prefix="PM> ">
Install-Package Google.Apis.Calendar.v3
</pre>
Visi prefiksa gadījumi, kas pievienoti, izmantojot klasi "devsite-terminal", tiks izslēgti no lietotāja kopētā koda.
Izcelšana
Izmantojiet <strong>
, lai pievērstu uzmanību saturam blokā <pre>
. Šādi rīkojoties, apkārtējais saturs tiks padarīts gaišāks, lai uzsvērtu <strong>
blokā iezīmēto sadaļu. Piemēram:
// ... // ... // ... for (i = 0; i < 10; i++) { printf("Counting %d\n", i); if (i % 3 == 0) { someFunc(i); } } // ... // ... // ...
Kods:
<pre class="prettyprint">
// ...
// ...
// ...
for (i = 0; i < 10; i++) {
printf("Counting %d\n", i);
<strong>if (i % 3 == 0) {
someFunc(i);
}</strong>
}
// ...
// ...
// ...
</pre>
Nomaināmi mainīgie
Izmantojiet <var>
un lielos burtus ar pasvītrām, lai aizstātu tekstu sadaļā <pre>
. Piemēram:
dev_appserver.py YOUR_APP_DIR.
Kods:
<pre>dev_appserver.py <var>YOUR_APP_DIR</var></pre>
Sadaļā Markdown ievietojiet tagus <var>
pēdiņās un izmantojiet Jinja izteiksmes iekavas, lai atkāptos no tagiem, piemēram: VAR_NAME
.
Piemēram:
Hello, my name is YOUR_NAME.
Kods:
```
Hello, my name is YOUR_NAME.
```
Markdown
Varat arī norādīt koda blokus, izmantojot Markdown ar 4 atstarpju atkāpi kodā vai norobežojot to ar 3 atzīmēm (```).
Piemēram:
```
print("hello world")
```
print("hello world")
abi kļūst
<pre class="prettyprint notranslate" translate="no"><code>
print("hello world")
</code></pre>
Ja izmantojat norobežotus kodu blokus (un bez atkāpes koda blokus), varat arī norādīt prettyprint valodu, lai to saprastu:
print("hello world")
kļūst
<pre class="prettyprint notranslate lang-py" translate="no"><code>
print("hello world")
</code></pre>
Atzīto valodu sarakstu varat atrast Prettify dokumentācijā .
Visiem koda blokiem, kas izveidoti, izmantojot Markdown, tiks piemērota diezganprint klase, ja vien valoda nav skaidri iestatīta uz None. Koda blokam var pievienot papildu klases, izmantojot pielāgotus atribūtus :
The program completed successfully.
kļūst
<pre class="devsite-disable-click-to-copy"><code>The program completed successfully.
</code></pre>