teratail
回答率
85.30%
teratail header banner
teratail header banner
質問するログイン新規登録
トップに関する質問世界標準の「Java Docの書き方」。

編集履歴

質問編集履歴

16

Mio

2015/08/06 07:03

投稿

退会済みユーザー
title CHANGED
File without changes
body CHANGED
@@ -67,7 +67,7 @@
67
67
  * @since : 1.0 : 2015/05/01
68
68
  * @author : mio.asakura
69
69
  *
70
- * Copyright (c) Mindc Co.,Ltd.<br>
70
+ * Copyright (c) Mio Co.,Ltd.<br>
71
71
  *
72
72
  */
73
73
 

15

書き方を整えた

2015/08/06 07:03

投稿

退会済みユーザー
title CHANGED
File without changes
body CHANGED
@@ -53,11 +53,13 @@
53
53
  ■ファイル最上部に書くJava Docの書き方
54
54
  /**
55
55
  *
56
- * Copyright (c) Mindc Co.,Ltd.
56
+ * DBにアクセスするクラス。<br>
57
+ * その他、ごにょごにょ<br>
58
+ * <ul>
59
+ * <li>指定されたユーザID、パスワードが存在しない場合</li>
60
+ * <li>指定されたユーザアカウントが失効している場合</li>
61
+ * </ul>
57
62
  *
58
- * Filename: DB_Package.java
59
- * explain : DBにアクセスするクラス。
60
- *
61
63
  * ${package_name}
62
64
  * ${file_name}
63
65
  * ${project_name}
@@ -65,6 +67,8 @@
65
67
  * @since : 1.0 : 2015/05/01
66
68
  * @author : mio.asakura
67
69
  *
70
+ * Copyright (c) Mindc Co.,Ltd.<br>
71
+ *
68
72
  */
69
73
 
70
74
  補足１）変更履歴は、かけない。
@@ -75,6 +79,7 @@
75
79
  --------------------------------------------------------------------------
76
80
  ■クラスのJva Docの書き方
77
81
  /**
82
+ *
78
83
  * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br>
79
84
  * オープンの結果をtrue/false で返す。<br>
80
85
  * 以下の場合は、オープンエラーとなる。<br>
@@ -96,7 +101,8 @@
96
101
 
97
102
  --------------------------------------------------------------------------
98
103
  ■コンストラクタのJava Docの書き方
99
- /**
104
+ /**
105
+ *
100
106
  * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br>
101
107
  * オープンの結果をtrue/false で返す。<br>
102
108
  * 以下の場合は、オープンエラーとなる。<br>
@@ -118,7 +124,8 @@
118
124
 
119
125
  --------------------------------------------------------------------------
120
126
  ■メソッドのJava Docの書き方
121
- /**
127
+ /**
128
+ *
122
129
  * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br>
123
130
  * オープンの結果をtrue/false で返す。<br>
124
131
  * 以下の場合は、オープンエラーとなる。<br>
@@ -126,12 +133,16 @@
126
133
  * <li>指定されたユーザID、パスワードが存在しない場合</li>
127
134
  * <li>指定されたユーザアカウントが失効している場合</li>
128
135
  * </ul>
136
+ *
129
137
  * @since : 2015-05-01 / mio.asaka
130
138
  *
131
139
  * @param userId : int ユーザID
132
140
  * @param password : String パスワード
141
+ *
133
142
  * @return true の場合はオープン成功、false の場合はオープン失敗。
143
+ *
134
144
  * @throws SQLException DBのオープンに失敗した場合。
145
+ *
135
146
  */
136
147
  public boolean open(int userId, String password) {
137
148
  省略

14

誤記修正

2015/07/31 07:46

投稿

退会済みユーザー
title CHANGED
File without changes
body CHANGED
@@ -128,8 +128,8 @@
128
128
  * </ul>
129
129
  * @since : 2015-05-01 / mio.asaka
130
130
  *
131
- * @param userId ユーザID
131
+ * @param userId : int ユーザID
132
- * @param password パスワード
132
+ * @param password : String パスワード
133
133
  * @return true の場合はオープン成功、false の場合はオープン失敗。
134
134
  * @throws SQLException DBのオープンに失敗した場合。
135
135
  */

13

ecilpseに修正

2015/07/30 00:12

投稿

退会済みユーザー
title CHANGED
File without changes
body CHANGED
@@ -1,4 +1,4 @@
1
- ecilpsで、Java doc を書いています。
1
+ ecilpseで、Java doc を書いています。
2
2
 
3
3
  さらにご指摘を下さい。2015/07/23
4
4
 

12

br / ⇒ brへ修正

2015/07/29 23:52

投稿

退会済みユーザー
title CHANGED
File without changes
body CHANGED
@@ -75,9 +75,9 @@
75
75
  --------------------------------------------------------------------------
76
76
  ■クラスのJva Docの書き方
77
77
  /**
78
- * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br />
78
+ * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br>
79
- * オープンの結果をtrue/false で返す。<br />
79
+ * オープンの結果をtrue/false で返す。<br>
80
- * 以下の場合は、オープンエラーとなる。<br />
80
+ * 以下の場合は、オープンエラーとなる。<br>
81
81
  * <ul>
82
82
  * <li>指定されたユーザID、パスワードが存在しない場合</li>
83
83
  * <li>指定されたユーザアカウントが失効している場合</li>
@@ -97,9 +97,9 @@
97
97
  --------------------------------------------------------------------------
98
98
  ■コンストラクタのJava Docの書き方
99
99
  /**
100
- * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br />
100
+ * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br>
101
- * オープンの結果をtrue/false で返す。<br />
101
+ * オープンの結果をtrue/false で返す。<br>
102
- * 以下の場合は、オープンエラーとなる。<br />
102
+ * 以下の場合は、オープンエラーとなる。<br>
103
103
  * <ul>
104
104
  * <li>指定されたユーザID、パスワードが存在しない場合</li>
105
105
  * <li>指定されたユーザアカウントが失効している場合</li>
@@ -119,9 +119,9 @@
119
119
  --------------------------------------------------------------------------
120
120
  ■メソッドのJava Docの書き方
121
121
  /**
122
- * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br />
122
+ * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br>
123
- * オープンの結果をtrue/false で返す。<br />
123
+ * オープンの結果をtrue/false で返す。<br>
124
- * 以下の場合は、オープンエラーとなる。<br />
124
+ * 以下の場合は、オープンエラーとなる。<br>
125
125
  * <ul>
126
126
  * <li>指定されたユーザID、パスワードが存在しない場合</li>
127
127
  * <li>指定されたユーザアカウントが失効している場合</li>

11

記述漏れ修正

2015/07/28 09:00

投稿

退会済みユーザー
title CHANGED
File without changes
body CHANGED
@@ -75,10 +75,14 @@
75
75
  --------------------------------------------------------------------------
76
76
  ■クラスのJva Docの書き方
77
77
  /**
78
+ * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br />
79
+ * オープンの結果をtrue/false で返す。<br />
80
+ * 以下の場合は、オープンエラーとなる。<br />
81
+ * <ul>
82
+ * <li>指定されたユーザID、パスワードが存在しない場合</li>
83
+ * <li>指定されたユーザアカウントが失効している場合</li>
84
+ * </ul>
78
85
  *
79
- * explain : DBアクセスクラス
80
- * / class : DB_Package
81
- *
82
86
  * @since : 2015-05-01
83
87
  * @author : mio.asakura
84
88
  *
@@ -92,10 +96,15 @@
92
96
 
93
97
  --------------------------------------------------------------------------
94
98
  ■コンストラクタのJava Docの書き方
99
+ /**
100
+ * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br />
101
+ * オープンの結果をtrue/false で返す。<br />
102
+ * 以下の場合は、オープンエラーとなる。<br />
103
+ * <ul>
104
+ * <li>指定されたユーザID、パスワードが存在しない場合</li>
105
+ * <li>指定されたユーザアカウントが失効している場合</li>
106
+ * </ul>
95
- *
107
+ *
96
- * explain : コンストラクター
97
- * / functin : DB_Package()
98
- *
99
108
  * @since : 2015-05-01 / mio.asakura
100
109
  *
101
110
  */
@@ -109,7 +118,6 @@
109
118
 
110
119
  --------------------------------------------------------------------------
111
120
  ■メソッドのJava Docの書き方
112
-
113
121
  /**
114
122
  * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br />
115
123
  * オープンの結果をtrue/false で返す。<br />
@@ -118,7 +126,8 @@
118
126
  * <li>指定されたユーザID、パスワードが存在しない場合</li>
119
127
  * <li>指定されたユーザアカウントが失効している場合</li>
120
128
  * </ul>
129
+ * @since : 2015-05-01 / mio.asaka
121
- *
130
+ *
122
131
  * @param userId ユーザID
123
132
  * @param password パスワード
124
133
  * @return true の場合はオープン成功、false の場合はオープン失敗。

10

ご指摘まち

2015/07/28 00:52

投稿

退会済みユーザー
title CHANGED
@@ -1,1 +1,1 @@
1
- 世界標準の「Java Docの書き方」。※主にecilpsユーザー用
1
+ 世界標準の「Java Docの書き方」。
body CHANGED
@@ -1,5 +1,7 @@
1
1
  ecilpsで、Java doc を書いています。
2
2
 
3
+ さらにご指摘を下さい。2015/07/23
4
+
3
5
  2015/07/23 追記
4
6
  メソッドのJava Docの書き方をガラッと変えました。
5
7
  すばらしい、出力結果の表示になり、とても読みやすくなります。

9

かなり見やすいメソッドのJava Docの書き方へ変更

2015/07/28 00:02

投稿

退会済みユーザー
title CHANGED
File without changes
body CHANGED
@@ -1,5 +1,9 @@
1
1
  ecilpsで、Java doc を書いています。
2
2
 
3
+ 2015/07/23 追記
4
+ メソッドのJava Docの書き方をガラッと変えました。
5
+ すばらしい、出力結果の表示になり、とても読みやすくなります。
6
+
3
7
  2015/07/27 追記
4
8
  下記、ここでお聞きしたのやURL, Java Docのページ、eclispでエラーがでない逃げ方を
5
9
  ５０回くらい試して作った、Java Docの書き方ですが、
@@ -104,24 +108,21 @@
104
108
  --------------------------------------------------------------------------
105
109
  ■メソッドのJava Docの書き方
106
110
 
107
- /**
111
+ /**
112
+ * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br />
113
+ * オープンの結果をtrue/false で返す。<br />
114
+ * 以下の場合は、オープンエラーとなる。<br />
115
+ * <ul>
116
+ * <li>指定されたユーザID、パスワードが存在しない場合</li>
117
+ * <li>指定されたユーザアカウントが失効している場合</li>
118
+ * </ul>
108
- *
119
+ *
109
- * explain : DBープン
110
- * / functin : open()
111
- *
112
- * @since : 2015-05-01 / mio.asakura
113
- *
114
- * @param strStruct : String SQL文
120
+ * @param userId ユーザID
115
- * @param sample : int サンプル番号
121
+ * @param password パスワード
116
- * @param sample2 : int サンプル番号2
117
- × * @param Nothing
118
- *
119
- * @return {@code true:成功}, {@code false:失敗}
122
+ * @return true の場合はオープン成功、false の場合はオープン失敗。
120
- *
121
- * @exception RuntimeException
123
+ * @throws SQLException DBのオープンに失敗した場合。
122
- *
123
- */
124
+ */
124
- public boolean open() {
125
+ public boolean open(int userId, String password) {
125
126
  省略
126
127
  )
127
128
 

8

タイトル変更

2015/07/28 00:01

投稿

退会済みユーザー
title CHANGED
@@ -1,1 +1,1 @@
1
- Java Docの書き方の総まとめですが、指摘をお願いします。
1
+ 世界標準の「Java Docの書き方」。※主にecilpsユーザー用
body CHANGED
File without changes

7

大手のコーディング規約を見た結果

2015/07/27 23:11

投稿

退会済みユーザー
title CHANGED
File without changes
body CHANGED
@@ -1,5 +1,6 @@
1
1
  ecilpsで、Java doc を書いています。
2
2
 
3
+ 2015/07/27 追記
3
4
  下記、ここでお聞きしたのやURL, Java Docのページ、eclispでエラーがでない逃げ方を
4
5
  ５０回くらい試して作った、Java Docの書き方ですが、
5
6
 
@@ -7,9 +8,12 @@
7
8
  間違っているとか、もっと情報をいれれるよとか、
8
9
  変更履歴の入れ方など、ご指摘をください。
9
10
 
11
+ 2015/07/28 追記
12
+ 大手のコーディング規約を一通りしました。Oracleを含め、日本の大手企業。
13
+ 下記が、一番ベストと判断します。
10
14
 
11
-
15
+ ----------------------------------------------------------------------------
12
- それで、教科書どおり（＝どの教科書？）に、Java Docを書いていたのですが、
16
+ 教科書どおり（＝どの教科書？）に、Java Docを書いていたのですが、
13
17
  ecilpsで、出力すると、エラーやワーニングが全部にでて、
14
18
  出力結果もぼろぼろでした。
15
19
 

6

世界一の書き方

2015/07/27 23:08

投稿

退会済みユーザー
title CHANGED
File without changes
body CHANGED
@@ -73,10 +73,10 @@
73
73
  * @author : mio.asakura
74
74
  *
75
75
  */
76
- public class DB_Package extends Object implements java.io.Serializable
76
+ public class DB_Package extends Object implements java.io.Serializable
77
- {
77
+ {
78
- 省略
78
+ 省略
79
- }
79
+ }
80
80
 
81
81
  補足）これ以上、書けない。これ以上色々書くと、ワーニングがでる。
82
82
 
@@ -108,9 +108,9 @@
108
108
  * @since : 2015-05-01 / mio.asakura
109
109
  *
110
110
  * @param strStruct : String SQL文
111
- * @param sample : int サンプル番号
111
+ * @param sample : int サンプル番号
112
- * @param sample2 : int サンプル番号2
112
+ * @param sample2 : int サンプル番号2
113
- × * @param Nothing
113
+ × * @param Nothing
114
114
  *
115
115
  * @return {@code true:成功}, {@code false:失敗}
116
116
  *

5

質問を明確にした。

2015/07/27 08:52

投稿

退会済みユーザー
title CHANGED
@@ -1,1 +1,1 @@
1
- Java Docの書き方の総まとめ
1
+ Java Docの書き方の総まとめですが、指摘をお願いします。
body CHANGED
@@ -1,5 +1,14 @@
1
1
  ecilpsで、Java doc を書いています。
2
2
 
3
+ 下記、ここでお聞きしたのやURL, Java Docのページ、eclispでエラーがでない逃げ方を
4
+ ５０回くらい試して作った、Java Docの書き方ですが、
5
+
6
+ まだ、改善の余地が沢山あると思います。
7
+ 間違っているとか、もっと情報をいれれるよとか、
8
+ 変更履歴の入れ方など、ご指摘をください。
9
+
10
+
11
+
3
12
  それで、教科書どおり（＝どの教科書？）に、Java Docを書いていたのですが、
4
13
  ecilpsで、出力すると、エラーやワーニングが全部にでて、
5
14
  出力結果もぼろぼろでした。

4

微調整をしました。

2015/07/27 05:41

投稿

退会済みユーザー
title CHANGED
File without changes
body CHANGED
@@ -57,8 +57,8 @@
57
57
  ■クラスのJva Docの書き方
58
58
  /**
59
59
  *
60
- * explain: DBアクセスクラス
60
+ * explain : DBアクセスクラス
61
- * / class: DB_Package
61
+ * / class : DB_Package
62
62
  *
63
63
  * @since : 2015-05-01
64
64
  * @author : mio.asakura
@@ -74,8 +74,8 @@
74
74
  --------------------------------------------------------------------------
75
75
  ■コンストラクタのJava Docの書き方
76
76
  *
77
- * explain: コンストラクター
77
+ * explain : コンストラクター
78
- * / functin: DB_Package()
78
+ * / functin : DB_Package()
79
79
  *
80
80
  * @since : 2015-05-01 / mio.asakura
81
81
  *
@@ -93,8 +93,8 @@
93
93
 
94
94
  /**
95
95
  *
96
- * explain: DBープン
96
+ * explain : DBープン
97
- * / functin: open()
97
+ * / functin : open()
98
98
  *
99
99
  * @since : 2015-05-01 / mio.asakura
100
100
  *

3

プロシージャーの書き方追加

2015/07/27 00:46

投稿

退会済みユーザー
title CHANGED
File without changes
body CHANGED
@@ -99,6 +99,8 @@
99
99
  * @since : 2015-05-01 / mio.asakura
100
100
  *
101
101
  * @param strStruct : String SQL文
102
+ * @param sample : int サンプル番号
103
+ * @param sample2 : int サンプル番号2
102
104
  × * @param Nothing
103
105
  *
104
106
  * @return {@code true:成功}, {@code false:失敗}

2

メソッドの書き方修正

2015/07/26 05:20

投稿

退会済みユーザー
title CHANGED
File without changes
body CHANGED
@@ -98,7 +98,8 @@
98
98
  *
99
99
  * @since : 2015-05-01 / mio.asakura
100
100
  *
101
+ * @param strStruct : String SQL文
101
- * @param Nothing
102
+ × * @param Nothing
102
103
  *
103
104
  * @return {@code true:成功}, {@code false:失敗}
104
105
  *

1

クラスの書き方修正

2015/07/26 05:08

投稿

退会済みユーザー
title CHANGED
File without changes
body CHANGED
@@ -43,8 +43,7 @@
43
43
  * ${file_name}
44
44
  * ${project_name}
45
45
  *
46
- * @since : 1.0
47
- * @since : 2015/05/01
46
+ * @since : 1.0 : 2015/05/01
48
47
  * @author : mio.asakura
49
48
  *
50
49
  */