- WSOFT Docs
- ブログ
- 共同作成ガイド
-
製品
- 製品
- PCMX
- WSOFTアカウント
- AliceScript
- AliceScript
- 謝辞
- ダウンロード
- Alice(キャラクター)
- AliceScriptのツアー
- Wikiの概要
- APIブラウザー
- APIブラウザー
- Alice
- break
- continue
- delay
- do
- exit
- for
- foreach
- function
- if
- import
- include
- lock
- read
- return
- string_format
- switch
- using
- while
- write
- Diagnostics
- Environment
- env_clr_version
- env_commandLine
- env_commandLineArgs
- env_set_exitCode
- env_expand_environmentVariables
- env_get_environmentVariable
- env_hasShutdownStarted
- env_impl_architecture
- env_impl_location
- env_impl_name
- env_impl_target
- env_impl_version
- env_Is64BitOperatingSystem
- env_Is64BitProcess
- env_MachineName
- env_NewLine
- env_os_platform
- env_os_version
- env_set_environmentVariable
- Exception
- Interpreter
- gc_collect
- gc_collectAfterExecute
- gc_getTotalMemory
- interpreter_append_output
- interpreter_append_output
- interpreter_consts
- interpreter_namespaces
- interpreter_getVariable
- interpreter_globalVariables
- interpreter_name
- interpreter_nameexists
- interpreter_namespaces
- interpreter_process
- interpreter_processfile
- interpreter_reset_variables
- Type
- Math
- math_abs
- math_acos
- math_acosh
- math_atan
- math_atan2
- math_atanh
- math_bitdecrement
- math_bitincrement
- math_cbrt
- math_celling
- math_clamp
- math_copysign
- math_cos
- math_cosh
- math_e
- math_exp
- math_factorial
- math_floor
- math_fusedmultiplyadd
- math_isFinite
- math_isInfinity
- math_isNaN
- math_isNegativeInfinity
- math_isNormal
- math_isPositiveInfinity
- math_isprime
- math_isSubNormal
- math_max
- math_min
- math_pi
- math_pow
- math_round
- math_sin
- math_sinh
- math_sqrt
- math_tan
- math_tanh
- math_tau
- math_truncate
- Net
- Parsing
- Random
- Security
- Threading
- Array
- Bool
- Bytes
- Delegate
- None
- Number
- String
- string
- CompareTo
- Contains
- EndsWith
- Equals
- Format
- GetBytes
- Indent
- IndexOf
- Insert
- IsEmptyOrNull
- IsEmptyOrWhiteSpace
- IsNormalized
- Join
- LastIndexOf
- Normalize
- PadCenter
- PadLeft
- PadRight
- Remove
- RemoveAt
- Repeat
- Replace
- ReplaceLineEndings
- Split
- SplitLines
- StartsWith
- SubString
- ToLower
- ToLowerInvariant
- ToUpper
- ToUpperInvariant
- Trim
- Trim
- TrimStart
- Variable
- 変更履歴
- 例外
- 例外
- 0x000 NONE
- 0x001 COULDNT_FIND_FUNCTION
- 0x003 INVALID_OPERAND
- 0x004 COULDNT_FIND_VARIABLE
- 0x005 ITS_RESERVED_NAME
- 0x006 ILLEGAL_IDENTIFIER
- 0x009 INCOMPLETE_ARGUMENTS
- 0x01a COULDNT_ADD_PARAMETERS_AFTER_PARMS_KEYWORD
- 0x020 COULDNT_EXECUTE_BLOCK
- 0x021 NEED_BRACKETS
- 0x022 UNNEED_TO_BRACKETS
- 0x04a CASE_BLOCK_MISSING_BREAK
- 0x04b UNKNOWN_ESCAPE_CHAR
- 基本
- Alice in Discord
- 相互運用
- チュートリアル
- ダウンロードセンター
- ほめて.ws
- アイコンメーカー
- WSOFTScript
- Unidet
- WebSailing
- WSNET
- WSTodon
- WSTube
- Lantana
- 法的資料
-
あみうは
- あみうは
- 新学期が始まりました!
- 恋の相談
- プチコン3号で作ったのは?
- オススメの文庫
- マクドナルド最高!
- ios11β レビュー
- あみうはの歌について
- ついに自分のソフトウェアのホームページができました。
- Windowsタブレットをリセットして起動しなくなった人のために
- PCレスで YouTubeの曲を携帯mp3プレイヤーで聴く(iPhone)
- 食べられないラズベリーパイを買いました。(1)
- ラズベリーパイの下ごしらえ(2)
- 小説始めます~
- 女子がキュンとくる行動ベスト3!!
- MacとWindowsについてあまり知られていない事
- macでできる裏技
- ドコモの格安スマホ「MONO」買っちゃいました☆いい所をいくつか
- 『レビュー』iPhone6sを1年間使い続けて思ったこと
- iPhoneの拡大鏡に関するバクを発見しました。
- iPhoneで圧縮ファイルを作成したり解凍する方法
- Obscura2が今だけ無料!使い方まとめ
- Windowsタブレットがブルースクリーンになった時のメモ
- お知らせ
コードの埋め込み方
この記事では、WSOFTDocsで公開されている記事にコードを埋め込む方法について説明します
WSOFTDocsで公開されている記事にコードを埋め込むには、次の3つの方法があります。
インライン形式のコード
インライン形式のコードで表すべき要素は、プログラミング言語のキーワード、クラス名、関数名などです。どれをこの形式で表すべきかは、明確に決まっていませんが、判断に迷う場合はテキストの書式設定に関する指針を参照してください。
インライン形式でコードを表すには、バッククオート(`)でテキストを囲みます。 次に例を示します。
Markdown | 実際の表示 |
---|---|
AliceScriptでは、`print(string text);`という関数を使用して標準出力にテキストを書き込みます。 | AliceScriptでは、print(string text); という関数を使用して標準出力にテキストを書き込みます。 |
プレースホルダー
提供するコードのうち、ユーザーが一部を各々に応じて置換できるようにするには、山かっこで囲んだプレースホルダーを使用しましょう。次に例を示します。
echo <好きなテキスト>
波かっこは、プレースホルダーとして使用しないでください。波かっこは、文字列補間やテンプレート構文など、一部のプログラミング言語で意味を持つ表記となり、間違いのもとになります。
リンク
場合によっては、実際のコードへを埋め込む代わりにリンクを設置することは、コードを埋め込むより適切である場合があります。
リンクにコードを使用しない
読者がリンクかどうか判別することが難しくなるため、リンクのテキストにコード要素を使用しないでください。
次に例を示します。
この関数は、[env_newline](../products/alice/api/alice/environment/env_newline.md)の戻り値を使用します。
2回目以降は、`env_newline`のようにコード形式で十分でしょう。
この関数は、env_newlineの戻り値を使用します。
2回目以降は、env_newline
のようにコード形式で十分でしょう。
スクリーンショット
ドキュメント内にコードを埋め込む方法として、スクリーンショットを使用しないでください。 スクリーンショットは、他の方法と比較して、以下のような問題点があります。
- コードをコピーできない
- 検索エンジンに認識されない
- 読み上げ機能などユーザー補助機能が使用できない
コードブロック
記事ファイル内のテキストがプログラムコードであることを表すには、バッククォート3つを使用してフェンスを作成します。
コードブロック内で使用されているプログラミング言語を指定するには、開始時のバッククォートの後に言語名を記述します。
コードブロックのタイトルは必ずつけてください。タイトルはtitle=
の後で指定できます。
マークダウン表記
```json title="Jsonの例"
{
"name": "John Doe",
"age": 30,
"city": "New York",
"isStudent": false,
"grades": [85, 90, 78],
"address": {
"street": "123 Main St",
"zipCode": "10001"
}
}
表示
```json title="Jsonの例"
{
"name": "John Doe",
"age": 30,
"city": "New York",
"isStudent": false,
"grades": [85, 90, 78],
"address": {
"street": "123 Main St",
"zipCode": "10001"
}
}
使用できる言語と言語名の詳細については、「Language names and aliases」を参照してください。
注意
Word文章やiPadのメモ帳などからコードをコピーして貼り付ける場合は、コード内に”
や“
などの無効なクォーテーションが含まれていないことを確認してください。そのような文字はすべて'
や"
に戻しましょう。