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

編集履歴

質問編集履歴

16

Mio

2015/08/06 07:03

投稿

退会済みユーザー
test CHANGED
File without changes
test CHANGED
@@ -136,7 +136,7 @@
136
136
 
137
137
  *
138
138
 
139
- * Copyright (c) Mindc Co.,Ltd.<br>
139
+ * Copyright (c) Mio Co.,Ltd.<br>
140
140
 
141
141
  *
142
142
 

15

書き方を整えた

2015/08/06 07:03

投稿

退会済みユーザー
test CHANGED
File without changes
test CHANGED
@@ -108,13 +108,17 @@
108
108
 
109
109
  *
110
110
 
111
- * Copyright (c) Mindc Co.,Ltd.
112
-
113
- *
114
-
115
- * Filename: DB_Package.java
116
-
117
- * explain : DBにアクセスするクラス。
111
+ * DBにアクセスするクラス。<br>
112
+
113
+ * その他、ごにょごにょ<br>
114
+
115
+ * <ul>
116
+
117
+ * <li>指定されたユーザID、パスワードが存在しない場合</li>
118
+
119
+ * <li>指定されたユーザアカウントが失効している場合</li>
120
+
121
+ * </ul>
118
122
 
119
123
  *
120
124
 
@@ -132,6 +136,10 @@
132
136
 
133
137
  *
134
138
 
139
+ * Copyright (c) Mindc Co.,Ltd.<br>
140
+
141
+ *
142
+
135
143
  */
136
144
 
137
145
 
@@ -152,6 +160,8 @@
152
160
 
153
161
  /**
154
162
 
163
+ *
164
+
155
165
  * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br>
156
166
 
157
167
  * オープンの結果をtrue/false で返す。<br>
@@ -194,7 +204,9 @@
194
204
 
195
205
  ■コンストラクタのJava Docの書き方
196
206
 
197
- /**
207
+ /**
208
+
209
+ *
198
210
 
199
211
  * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br>
200
212
 
@@ -238,7 +250,9 @@
238
250
 
239
251
  ■メソッドのJava Docの書き方
240
252
 
241
- /**
253
+ /**
254
+
255
+ *
242
256
 
243
257
  * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br>
244
258
 
@@ -254,6 +268,8 @@
254
268
 
255
269
  * </ul>
256
270
 
271
+ *
272
+
257
273
  * @since : 2015-05-01 / mio.asaka
258
274
 
259
275
  *
@@ -262,10 +278,16 @@
262
278
 
263
279
  * @param password : String パスワード
264
280
 
281
+ *
282
+
265
283
  * @return true の場合はオープン成功、false の場合はオープン失敗。
266
284
 
285
+ *
286
+
267
287
  * @throws SQLException DBのオープンに失敗した場合。
268
288
 
289
+ *
290
+
269
291
  */
270
292
 
271
293
  public boolean open(int userId, String password) {

14

誤記修正

2015/07/31 07:46

投稿

退会済みユーザー
test CHANGED
File without changes
test CHANGED
@@ -258,9 +258,9 @@
258
258
 
259
259
  *
260
260
 
261
- * @param userId ユーザID
261
+ * @param userId : int ユーザID
262
-
262
+
263
- * @param password パスワード
263
+ * @param password : String パスワード
264
264
 
265
265
  * @return true の場合はオープン成功、false の場合はオープン失敗。
266
266
 

13

ecilpseに修正

2015/07/30 00:12

投稿

退会済みユーザー
test CHANGED
File without changes
test CHANGED
@@ -1,4 +1,4 @@
1
- ecilpsで、Java doc を書いています。
1
+ ecilpseで、Java doc を書いています。
2
2
 
3
3
 
4
4
 

12

br / ⇒ brへ修正

2015/07/29 23:52

投稿

退会済みユーザー
test CHANGED
File without changes
test CHANGED
@@ -152,11 +152,11 @@
152
152
 
153
153
  /**
154
154
 
155
- * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br />
155
+ * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br>
156
-
156
+
157
- * オープンの結果をtrue/false で返す。<br />
157
+ * オープンの結果をtrue/false で返す。<br>
158
-
158
+
159
- * 以下の場合は、オープンエラーとなる。<br />
159
+ * 以下の場合は、オープンエラーとなる。<br>
160
160
 
161
161
  * <ul>
162
162
 
@@ -196,11 +196,11 @@
196
196
 
197
197
  /**
198
198
 
199
- * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br />
199
+ * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br>
200
-
200
+
201
- * オープンの結果をtrue/false で返す。<br />
201
+ * オープンの結果をtrue/false で返す。<br>
202
-
202
+
203
- * 以下の場合は、オープンエラーとなる。<br />
203
+ * 以下の場合は、オープンエラーとなる。<br>
204
204
 
205
205
  * <ul>
206
206
 
@@ -240,11 +240,11 @@
240
240
 
241
241
  /**
242
242
 
243
- * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br />
243
+ * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br>
244
-
244
+
245
- * オープンの結果をtrue/false で返す。<br />
245
+ * オープンの結果をtrue/false で返す。<br>
246
-
246
+
247
- * 以下の場合は、オープンエラーとなる。<br />
247
+ * 以下の場合は、オープンエラーとなる。<br>
248
248
 
249
249
  * <ul>
250
250
 

11

記述漏れ修正

2015/07/28 09:00

投稿

退会済みユーザー
test CHANGED
File without changes
test CHANGED
@@ -152,11 +152,19 @@
152
152
 
153
153
  /**
154
154
 
155
+ * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br />
156
+
157
+ * オープンの結果をtrue/false で返す。<br />
158
+
159
+ * 以下の場合は、オープンエラーとなる。<br />
160
+
155
- *
161
+ * <ul>
162
+
156
-
163
+ * <li>指定されたユーザID、パスワードが存在しない場合</li>
164
+
165
+ * <li>指定されたユーザアカウントが失効している場合</li>
166
+
157
- * explain : DBアクセスクラス
167
+ * </ul>
158
-
159
- * / class : DB_Package
160
168
 
161
169
  *
162
170
 
@@ -186,18 +194,28 @@
186
194
 
187
195
  ■コンストラクタのJava Docの書き方
188
196
 
197
+ /**
198
+
199
+ * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br />
200
+
201
+ * オープンの結果をtrue/false で返す。<br />
202
+
203
+ * 以下の場合は、オープンエラーとなる。<br />
204
+
205
+ * <ul>
206
+
207
+ * <li>指定されたユーザID、パスワードが存在しない場合</li>
208
+
209
+ * <li>指定されたユーザアカウントが失効している場合</li>
210
+
211
+ * </ul>
212
+
213
+ *
214
+
215
+ * @since : 2015-05-01 / mio.asakura
216
+
189
217
  *
190
218
 
191
- * explain : コンストラクター
192
-
193
- * / functin : DB_Package()
194
-
195
- *
196
-
197
- * @since : 2015-05-01 / mio.asakura
198
-
199
- *
200
-
201
219
  */
202
220
 
203
221
  public DB_Package()
@@ -220,8 +238,6 @@
220
238
 
221
239
  ■メソッドのJava Docの書き方
222
240
 
223
-
224
-
225
241
  /**
226
242
 
227
243
  * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br />
@@ -238,7 +254,9 @@
238
254
 
239
255
  * </ul>
240
256
 
257
+ * @since : 2015-05-01 / mio.asaka
258
+
241
- *
259
+ *
242
260
 
243
261
  * @param userId ユーザID
244
262
 

10

ご指摘まち

2015/07/28 00:52

投稿

退会済みユーザー
test CHANGED
@@ -1 +1 @@
1
- 世界標準の「Java Docの書き方」。※主にecilpsユーザー用
1
+ 世界標準の「Java Docの書き方」。
test CHANGED
@@ -2,6 +2,10 @@
2
2
 
3
3
 
4
4
 
5
+ さらにご指摘を下さい。2015/07/23
6
+
7
+
8
+
5
9
  2015/07/23 追記
6
10
 
7
11
  メソッドのJava Docの書き方をガラッと変えました。

9

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

2015/07/28 00:02

投稿

退会済みユーザー
test CHANGED
File without changes
test CHANGED
@@ -2,6 +2,14 @@
2
2
 
3
3
 
4
4
 
5
+ 2015/07/23 追記
6
+
7
+ メソッドのJava Docの書き方をガラッと変えました。
8
+
9
+ すばらしい、出力結果の表示になり、とても読みやすくなります。
10
+
11
+
12
+
5
13
  2015/07/27 追記
6
14
 
7
15
  下記、ここでお聞きしたのやURL, Java Docのページ、eclispでエラーがでない逃げ方を
@@ -210,41 +218,35 @@
210
218
 
211
219
 
212
220
 
213
- /**
221
+ /**
222
+
214
-
223
+ * 指定されたユーザID、パスワードで、DBのオープンを行なう。<br />
224
+
225
+ * オープンの結果をtrue/false で返す。<br />
226
+
227
+ * 以下の場合は、オープンエラーとなる。<br />
228
+
229
+ * <ul>
230
+
231
+ * <li>指定されたユーザID、パスワードが存在しない場合</li>
232
+
233
+ * <li>指定されたユーザアカウントが失効している場合</li>
234
+
235
+ * </ul>
236
+
215
- *
237
+ *
216
-
217
- * explain : DBープン
238
+
218
-
219
- * / functin : open()
220
-
221
- *
222
-
223
- * @since : 2015-05-01 / mio.asakura
224
-
225
- *
226
-
227
- * @param strStruct : String SQL文
239
+ * @param userId ユーザID
228
-
240
+
229
- * @param sample : int サンプル番号
241
+ * @param password パスワード
230
-
231
- * @param sample2 : int サンプル番号2
242
+
232
-
233
- × * @param Nothing
234
-
235
- *
236
-
237
- * @return {@code true:成功}, {@code false:失敗}
243
+ * @return true の場合はオープン成功、false の場合はオープン失敗。
238
-
239
- *
244
+
240
-
241
- * @exception RuntimeException
245
+ * @throws SQLException DBのオープンに失敗した場合。
242
-
243
- *
246
+
244
-
245
- */
247
+ */
246
-
248
+
247
- public boolean open() {
249
+ public boolean open(int userId, String password) {
248
250
 
249
251
  省略
250
252
 

8

タイトル変更

2015/07/28 00:01

投稿

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

7

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

2015/07/27 23:11

投稿

退会済みユーザー
test CHANGED
File without changes
test CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
 
4
4
 
5
+ 2015/07/27 追記
6
+
5
7
  下記、ここでお聞きしたのやURL, Java Docのページ、eclispでエラーがでない逃げ方を
6
8
 
7
9
  ５０回くらい試して作った、Java Docの書き方ですが、
@@ -16,11 +18,17 @@
16
18
 
17
19
 
18
20
 
19
-
21
+ 2015/07/28 追記
22
+
20
-
23
+ 大手のコーディング規約を一通りしました。Oracleを含め、日本の大手企業。
24
+
21
-
25
+ 下記が、一番ベストと判断します。
26
+
27
+
28
+
22
-
29
+ ----------------------------------------------------------------------------
30
+
23
- それで、教科書どおり（＝どの教科書？）に、Java Docを書いていたのですが、
31
+ 教科書どおり（＝どの教科書？）に、Java Docを書いていたのですが、
24
32
 
25
33
  ecilpsで、出力すると、エラーやワーニングが全部にでて、
26
34
 

6

世界一の書き方

2015/07/27 23:08

投稿

退会済みユーザー
test CHANGED
File without changes
test CHANGED
@@ -148,13 +148,13 @@
148
148
 
149
149
  */
150
150
 
151
- public class DB_Package extends Object implements java.io.Serializable
151
+ public class DB_Package extends Object implements java.io.Serializable
152
-
152
+
153
- {
153
+ {
154
-
154
+
155
- 省略
155
+ 省略
156
-
156
+
157
- }
157
+ }
158
158
 
159
159
 
160
160
 
@@ -218,11 +218,11 @@
218
218
 
219
219
  * @param strStruct : String SQL文
220
220
 
221
- * @param sample : int サンプル番号
221
+ * @param sample : int サンプル番号
222
-
222
+
223
- * @param sample2 : int サンプル番号2
223
+ * @param sample2 : int サンプル番号2
224
-
224
+
225
- × * @param Nothing
225
+ × * @param Nothing
226
226
 
227
227
  *
228
228
 

5

質問を明確にした。

2015/07/27 08:52

投稿

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

4

微調整をしました。

2015/07/27 05:41

投稿

退会済みユーザー
test CHANGED
File without changes
test CHANGED
@@ -116,9 +116,9 @@
116
116
 
117
117
  *
118
118
 
119
- * explain: DBアクセスクラス
119
+ * explain : DBアクセスクラス
120
-
120
+
121
- * / class: DB_Package
121
+ * / class : DB_Package
122
122
 
123
123
  *
124
124
 
@@ -150,9 +150,9 @@
150
150
 
151
151
  *
152
152
 
153
- * explain: コンストラクター
153
+ * explain : コンストラクター
154
-
154
+
155
- * / functin: DB_Package()
155
+ * / functin : DB_Package()
156
156
 
157
157
  *
158
158
 
@@ -188,9 +188,9 @@
188
188
 
189
189
  *
190
190
 
191
- * explain: DBープン
191
+ * explain : DBープン
192
-
192
+
193
- * / functin: open()
193
+ * / functin : open()
194
194
 
195
195
  *
196
196
 

3

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

2015/07/27 00:46

投稿

退会済みユーザー
test CHANGED
File without changes
test CHANGED
@@ -200,6 +200,10 @@
200
200
 
201
201
  * @param strStruct : String SQL文
202
202
 
203
+ * @param sample : int サンプル番号
204
+
205
+ * @param sample2 : int サンプル番号2
206
+
203
207
  × * @param Nothing
204
208
 
205
209
  *

2

メソッドの書き方修正

2015/07/26 05:20

投稿

退会済みユーザー
test CHANGED
File without changes
test CHANGED
@@ -198,7 +198,9 @@
198
198
 
199
199
  *
200
200
 
201
+ * @param strStruct : String SQL文
202
+
201
- * @param Nothing
203
+ × * @param Nothing
202
204
 
203
205
  *
204
206
 

1

クラスの書き方修正

2015/07/26 05:08

投稿

退会済みユーザー
test CHANGED
File without changes
test CHANGED
@@ -88,9 +88,7 @@
88
88
 
89
89
  *
90
90
 
91
- * @since : 1.0
92
-
93
- * @since : 2015/05/01
91
+ * @since : 1.0 : 2015/05/01
94
92
 
95
93
  * @author : mio.asakura
96
94