「コーディング規約」の版間の差分

提供:AliceScript Wiki
ナビゲーションに移動 検索に移動
(ページの作成:「コーディング規約は、よりよいプログラムを作るために推奨されるルールのことです。コーディング規約には、次の目的があ…」)
 
 
(同じ利用者による、間の2版が非表示)
1行目: 1行目:
 +
{{Alert|この記事のより新しい版が[https://docs.wsoft.ws/products/alice/general/coding-style/ WSOFTDocs]にあります。AliceScriptWikiでは、この記事はもう更新されません。||04}}
 
コーディング規約は、よりよいプログラムを作るために推奨されるルールのことです。コーディング規約には、次の目的があります。
 
コーディング規約は、よりよいプログラムを作るために推奨されるルールのことです。コーディング規約には、次の目的があります。
 
*コードの見た目が統一されるため、コードを読むときに、内容が理解しやすくなります。
 
*コードの見た目が統一されるため、コードを読むときに、内容が理解しやすくなります。
 
*コードの複製、変更、および保守が容易になります。
 
*コードの複製、変更、および保守が容易になります。
 +
=名前付け規則=
 +
ÅliceScriptコードを記述するときに考慮するべき名前付け規則がいくつかあります。
 +
==パスカルケース==
 +
パスカルケースとは、語間の空白を取り除いて連結し、構成語の先頭を大文字にする記法を指します。AliceScriptでは、<code>class</code>の名前付けにパスカルケースを使用することを推奨します。
 +
class TestClass
 +
{
 +
}
 +
<code>interface</code>に名前をつけるときには、パスカルケースを使用するだけでなく、その名前の先頭に<code>I</code>を付けます。これにより、コードの読み手にそれが<code>interface</code>であることが伝わります。
 +
interface ITestInterface
 +
{
 +
}

2023年6月30日 (金) 00:15時点における最新版

この記事のより新しい版がWSOFTDocsにあります。AliceScriptWikiでは、この記事はもう更新されません。

コーディング規約は、よりよいプログラムを作るために推奨されるルールのことです。コーディング規約には、次の目的があります。

  • コードの見た目が統一されるため、コードを読むときに、内容が理解しやすくなります。
  • コードの複製、変更、および保守が容易になります。

名前付け規則[編集]

ÅliceScriptコードを記述するときに考慮するべき名前付け規則がいくつかあります。

パスカルケース[編集]

パスカルケースとは、語間の空白を取り除いて連結し、構成語の先頭を大文字にする記法を指します。AliceScriptでは、classの名前付けにパスカルケースを使用することを推奨します。

class TestClass
{
}

interfaceに名前をつけるときには、パスカルケースを使用するだけでなく、その名前の先頭にIを付けます。これにより、コードの読み手にそれがinterfaceであることが伝わります。

interface ITestInterface
{
}