Skip to content

Commit 1b780b1

Browse files
authored
introduce eslint-plugin-markdown-links (#248)
* introduce eslint-plugin-markdown-links * update * fix * update * update
1 parent 11112a7 commit 1b780b1

13 files changed

+1347
-178
lines changed

.vscode/settings.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"eslint.validate": ["javascript", "javascriptreact", "vue"],
2+
"eslint.validate": ["javascript", "javascriptreact", "vue", "markdown"],
33
"editor.codeActionsOnSave": {
44
"source.fixAll.eslint": "explicit"
55
},

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
| 2 | [SQL コーディング規約](./documents/forSQL/) |
2828
| 3 | [AWS インフラリソース命名規約](./documents/forAWSResource/) |
2929
| 4 | [OpenAPI Specification 規約](./documents/forOpenAPISpecification/) |
30-
| 5 | [Gitブランチフロー規約](./documents/forGitBranch/) |
3130

3231
---
3332

documents/forAWSResource/AWSインフラリソース命名規約.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ stg-fuga-web-fileupload-bucket
209209
理由:
210210

211211
- AWS コンソールで見たときにどの AWS サービスのリソースを見ているか自明である
212-
- [Terraform の命名規則](https://www.terraform-best-practices.com/naming#resource-and-data-source-argument) にリソース名を繰り返さないという記載があり、整合性を持たせるため
212+
- [Terraform の命名規則](https://www.terraform-best-practices.com/naming#resource-and-data-source-arguments) にリソース名を繰り返さないという記載があり、整合性を持たせるため
213213

214214
> **Resource and data source arguments**
215215
> Do not repeat resource type in resource name (not partially, nor completely):
@@ -815,7 +815,7 @@ IAM グループ用のポリシーを作成する例では、company を含め
815815
- 将来の変更の影響を考慮する
816816
- AWS Organizations のタグポリシーを利用することで、組織が採用するタグ付け標準を自動的に適用する
817817

818-
より詳しいタグ付けのベストプラクティスも存在するが、本紙の範囲を超えるため紹介のみに留める。 [https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html](https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html)
818+
より詳しいタグ付けのベストプラクティスも存在するが、本紙の範囲を超えるため紹介のみに留める。 <https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html>
819819

820820
## タグキー
821821

documents/forJava/Javaコーディング規約.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ head:
1818

1919
一般に利用・参照されている Java コーディング規約やガイドラインを以下に示す。本規約の作成においても、下記規約類を参照・抜粋している。
2020

21-
| 規約 | 著作者 | URL |
22-
| ------------------------------------------------------ | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
23-
| Code Conventions for the Java Programming Language | Sun Microsystems | [http://www.oracle.com/technetwork/java/codeconvtoc-136057.html](http://www.oracle.com/technetwork/java/codeconvtoc-136057.html) |
24-
| Writing Robust Java Code | Scott W. Ambler | [http://www.ambysoft.com/downloads/javaCodingStandards.pdf](http://www.ambysoft.com/downloads/javaCodingStandards.pdf) |
25-
| オブジェクト倶楽部版 Java コーディング標準 | オブジェクト倶楽部 | [http://objectclub.jp/community/codingstandard/CodingStd.pdf](http://objectclub.jp/community/codingstandard/CodingStd.pdf) |
26-
| 電通国際情報際サービス版 Java コーディング規約 2004 | 電通国際情報サービス | [http://objectclub.jp/community/codingstandard/JavaCodingStandard2004.pdf](http://objectclub.jp/community/codingstandard/JavaCodingStandard2004.pdf) |
27-
| JJGuideline (Java - J2EE Conventions and Guidelines) | Stephan.J & JCS Team | [http://www.fedict.belgium.be/sites/default/files/downloads/Java_J2EE_conventions_and_guidelines_EN.pdf](http://www.fedict.belgium.be/sites/default/files/downloads/Java_J2EE_conventions_and_guidelines_EN.pdf) |
28-
| Google Java Style (非公式和訳) | Google | [https://kazurof.github.io/GoogleJavaStyle-ja/](https://kazurof.github.io/GoogleJavaStyle-ja/) |
29-
| Acroquest Technology Java コーディング規約 | Acroquest Technology | [https://www.acroquest.co.jp/webworkshop/javacordingrule/Acroquest_JavaCodingStandard_6_7.pdf](https://www.acroquest.co.jp/webworkshop/javacordingrule/Acroquest_JavaCodingStandard_6_7.pdf)<br>※現在は削除されています |
21+
| 規約 | 著作者 | URL |
22+
| ------------------------------------------------------ | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
23+
| Code Conventions for the Java Programming Language | Sun Microsystems | <http://www.oracle.com/technetwork/java/codeconvtoc-136057.html> |
24+
| Writing Robust Java Code | Scott W. Ambler | <http://www.ambysoft.com/downloads/javaCodingStandards.pdf> |
25+
| オブジェクト倶楽部版 Java コーディング標準 | オブジェクト倶楽部 | <http://objectclub.jp/community/codingstandard/CodingStd.pdf> |
26+
| 電通国際情報際サービス版 Java コーディング規約 2004 | 電通国際情報サービス | <http://objectclub.jp/community/codingstandard/JavaCodingStandard2004.pdf> |
27+
| JJGuideline (Java - J2EE Conventions and Guidelines) | Stephan.J & JCS Team | <http://www.fedict.belgium.be/sites/default/files/downloads/Java_J2EE_conventions_and_guidelines_EN.pdf><br>※現在は削除されています |
28+
| Google Java Style (非公式和訳) | Google | <https://kazurof.github.io/GoogleJavaStyle-ja/> |
29+
| Acroquest Technology Java コーディング規約 | Acroquest Technology | <https://www.acroquest.co.jp/webworkshop/javacordingrule/Acroquest_JavaCodingStandard_6_7.pdf><br>※現在は削除されています |
3030

3131
※ Sun Microsystems の規約は Java 草創期から一応の標準という位置づけだったが、オブジェクト指向、及び、その開発環境の普及・発展によって、設計やコーディングにおいて、直接的に有用な知識や豊富な指針を含むような優れた規約や、ツールなどによる機械的な準拠チェックと連携する規約が普及してきている。
3232

@@ -1378,7 +1378,7 @@ head:
13781378
- case 句はなるべく一つの式での記述を推奨する
13791379
複雑な式や複雑なステートメントを記述しなければならない場合は、メソッドに分割することを検討してください。
13801380
- switch 式は、コーディングミスによるフォールスルーを避けるため、常にアロー構文を使用する
1381-
[https://docs.oracle.com/javase/jp/16/language/switch-expressions.html](https://docs.oracle.com/javase/jp/16/language/switch-expressions.html)からの引用:
1381+
<https://docs.oracle.com/javase/jp/16/language/switch-expressions.html>からの引用:
13821382

13831383
> ノート:`case L ->`ラベルの使用をお薦めします。`case L:`ラベルの使用時は、`break`文または`yield`文の挿入を忘れがちです。これを忘れると、コード内で思いがけないフォール・スルーが発生する場合があります。
13841384
> `case L ->`ラベルで、複数の文または式でないコード、あるいは`throw`文を指定するには、それらをブロック内に囲みます。`case`ラベルが生成する値を`yield`文で指定します。
@@ -1489,7 +1489,7 @@ head:
14891489
- case 句はなるべく 1 行のステートメントでの記述を推奨する
14901490
複雑なステートメントを記述しなければならない場合は、メソッドに分割することを検討してください。
14911491
- switch 文は、コーディングミスによるフォールスルーを避けるため、なるべくアロー構文を使用することを推奨する
1492-
[https://docs.oracle.com/javase/jp/16/language/switch-expressions.html](https://docs.oracle.com/javase/jp/16/language/switch-expressions.html)からの引用:
1492+
<https://docs.oracle.com/javase/jp/16/language/switch-expressions.html>からの引用:
14931493

14941494
> ノート:`case L ->`ラベルの使用をお薦めします。`case L:`ラベルの使用時は、`break`文または`yield`文の挿入を忘れがちです。これを忘れると、コード内で思いがけないフォール・スルーが発生する場合があります。
14951495
> `case L ->`ラベルで、複数の文または式でないコード、あるいは`throw`文を指定するには、それらをブロック内に囲みます。`case`ラベルが生成する値を`yield`文で指定します。
@@ -1705,7 +1705,7 @@ head:
17051705
## ラムダ式・メソッド参照・コンストラクタ参照
17061706

17071707
- ラムダ式が利用できる箇所はラムダ式を利用してよい
1708-
[※パフォーマンスについても記載しているので参考にしてください](#ラムダ式・メソッド参照・コンストラクタ参照-2)
1708+
[※パフォーマンスについても記載しているので参考にしてください](#ラムダ式メソッド参照コンストラクタ参照-1)
17091709
- ただし、メソッド参照・コンストラクタ参照が利用できる場合はメソッド参照・コンストラクタ参照を利用する
17101710

17111711
良い例:
@@ -2499,7 +2499,7 @@ head:
24992499
(Eclipse の TODO コメント形式を採用)
25002500
例)
25012501
2502-
```
2502+
```java
25032503
//TODO:ワークフローの仕様決定待ち 関連チケット#12345
25042504
```
25052505
@@ -2509,8 +2509,8 @@ Java では 3 種類のコメントが使える。javadoc コメントは`/**`
25092509
25102510
| コメント種類 | 使用方法 | 例 |
25112511
| ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2512-
| javadoc コメント<br>`/** comment */` | interface、class、メソッド、フィールドの直前に書く。コメントは javadoc によって処理され、外部ドキュメント(HTML)として生成される。(この形式以外のコメントはドキュメントとして出力されないことに注意) | <code class="comment-code">/\*_<br> _ 顧客(Customer)-<br> _ 顧客はわれわれがサービスまたは製品を売った人物<br> _ もしくは組織のいずれかである。<br> _ @author 開発太郎<br> _/</code> |
2513-
| C 風コメント<br>`/* comment */` | 特定のコードを無効化したいが、後で使用するかもしれないので残しておくためにコメント化する時や、デバッグ時に一時的に無効化するときに使用する。 | <code class="comment-code">/_ <br> このコードは J.T.Kirk によって 1997.12.9 に前述のコードと置き換えたためコメント化した。2 年間不要であるならば削除せよ。<br> ... (ソースコード) <br> _/</code> |
2512+
| javadoc コメント<br>`/** comment */` | interface、class、メソッド、フィールドの直前に書く。コメントは javadoc によって処理され、外部ドキュメント(HTML)として生成される。(この形式以外のコメントはドキュメントとして出力されないことに注意) | <code class="comment-code">/\*\*<br> \* 顧客(Customer)-<br> \* 顧客はわれわれがサービスまたは製品を売った人物<br> \* もしくは組織のいずれかである。<br> \* @author 開発太郎<br> \*/</code> |
2513+
| C 風コメント<br>`/* comment */` | 特定のコードを無効化したいが、後で使用するかもしれないので残しておくためにコメント化する時や、デバッグ時に一時的に無効化するときに使用する。 | <code class="comment-code">/\*<br> このコードは J.T.Kirk によって 1997.12.9 に前述のコードと置き換えたためコメント化した。2 年間不要であるならば削除せよ。<br> ... (ソースコード) <br>\*/</code> |
25142514
| 単一行コメント<br>`// comment` | メソッド内にて、ビジネスロジック、コードの概要、一時変数の定義内容などを記述する。 | <code class="comment-code">// 1995 年 2 月に開始された X 氏の寛大なキャンペーンで<br>// 定められた通り 1000$を超える請求には、全て 5%割引を<br>// 適用する。</code> |
25152515
25162516
※ ロジック中に、頻繁に C 風コメントでコメントを書くとまとめてコメントアウトする場合に不便なため、基本的にロジック中では単一行コメントを利用すること。
@@ -2567,7 +2567,7 @@ List の処理を行う際、拡張 for 文で処理する場合は Iterator イ
25672567
小中規模の処理量であれば考慮するほどの性能差はありませんが、大量の処理が見込まれる場合は考慮が必要です。
25682568
また、Stream API は並列処理(スレッド処理)の機能をサポートしていますので、利用できる場合は並列処理も含めての検証が必要です。
25692569
2570-
<a id="ラムダ式・メソッド参照・コンストラクタ参照-2"></a>
2570+
<span id="ラムダ式メソッド参照コンストラクタ参照-1"></span>
25712571
25722572
## ラムダ式・メソッド参照・コンストラクタ参照
25732573

0 commit comments

Comments
 (0)