2020-02-24

Groovyのクロージャ ①クロージャ内のメソッド呼び出し基礎編

groovy

背景

JenkinsというCIツールではGroovyのコードでCI挙動を記述できるJenkins pipelineがあります。 Jenkins pipelineではGroovyのDSL(Domain-Specific Language:ドメイン固有言語)が使われています。 DSLにはクロージャが効果的に使用されています。

今回はクロージャの動作の基本編です。

クロージャとは

クロージャとは、生まれ故郷（クロージャ自身が定義された場所）を忘れない無名関数のことです。

こちらページが詳しいです。

koji-k.github.io

クロージャ内のメソッド呼び出し

生まれ故郷を忘れない無名関数とは何か、以下のプログラムで確認します。

MainクラスのclosureTest()内でPilpelineクラスのpipeline関数にクロージャ({と}で囲んだ部分)を渡しています。 (クラス名と関数名はJenkins pipelineを意識しています)

クロージャの内部ではa()を呼び出しています。a()はMainクラス、Pipelineクラス両方で定義されています。

pipeline()メソッド内で、渡されたクロージャ(cl)を実行しています。

class Pipeline {
    def pipeline(Closure cl) {
      println "before closure"
      cl()
      println "after closure"
    }

    def a() {
        println "I'm Pipeline.a"
    }
}

class Main {
    def closureTest() {
        def pipeline = new Pipeline()
        pipeline.pipeline {
            a()
        }
    }
    
    def a() {
        println "I'm Main.a"
    }
}

def main = new Main()
main.closureTest()

このコードを実行します。出力は以下のようになりました。

before closure
I'm Main.a
after closure

クロージャが実行されたとき、Main.a()が呼ばれていることがわかります。

このように、クロージャは呼ばれた場所でなく、定義された(クロージャが書かれた)場所で実行されます。難しくいうと、クロージャは変数名やメソッドの名前解決を、(デフォルトでは)定義された場所で行う、ということです。クロージャを実行する側(今回はPipelineクラス)での名前解決は行われません。

呼び出し元のメソッドは呼ばれるか

確認として、Main.a()を削除してみましょう。それ以外は上記と同じコードです。

class Pipeline {
    def pipeline(Closure cl) {
      println "before closure"
      cl()
      println "after closure"
    }

    def a() {
        println "I'm Pipeline.a"
    }
}

class Main {
    def closureTest() {
        def pipeline = new Pipeline()
        pipeline.pipeline {
            a()
        }
    }
    
//    def a() {
//        println "I'm Main.a"
//    }
}

def main = new Main()
main.closureTest()

実行します。エラーになりました。

before closure
Exception thrown

groovy.lang.MissingMethodException: No signature of method: Main.a() is applicable for argument types: () values: []
Possible solutions: any(), tap(groovy.lang.Closure), any(groovy.lang.Closure), is(java.lang.Object), wait(), wait(long)
    at Main$_closureTest_closure1.doCall(closure_01.groovy:18)
    at Main$_closureTest_closure1.doCall(closure_01.groovy)
    at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
    at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at Pipeline.pipeline(closure_01.groovy:4)
    at Pipeline$pipeline.call(Unknown Source)
    at Main.closureTest(closure_01.groovy:17)
    at Main$closureTest.call(Unknown Source)
    at closure_01.run(closure_01.groovy:36)
    at jdk.internal.reflect.GeneratedMethodAccessor60.invoke(Unknown Source)
    at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)

これにより、クロージャを実行したクラス/メソッド(今回はPipeline.pipeline())に定義されたメソッドはクロージャ内からは呼ばれないことが分かりました。

環境

Groovy Version: 3.0.1
JVM: 13.0.2
Vendor: Oracle Corporation
OS: Mac OS X

次回に続く

yucatio.hatenablog.com

2020-02-14

「ピーターからの問題」1から9までを使って分数の穴埋め算。解答のJavaScriptプログラム

算数 JavaScript プログラミングクイズ

Qiitaでこちらの問題をみたので、解いてみました。

これをjsで解けと会社の上司に言われたんですが全然わからん。
誰かわかります？笑 pic.twitter.com/ZM6VmigaVQ
— ケイセイ＠JavaScriptと仲良くなりたい (@keisei_otsuka) 2020年2月2日

アルゴリズム

考えることは大きく分けて以下の2つです。

1から9を1回ずつ使った組み合わせを列挙する
分数を計算して1かどうか確かめる

1から9を1回ずつ使った組み合わせを列挙する

こちらのアルゴリズムを利用して、1から9を1回ずつ使った組み合わせを列挙します。

yucatio.hatenablog.com

分数を計算して1かどうか確かめる

今回、分数の計算が必要に思えますが、式を以下のように変形すれば、分数を使わずとも解けることがわかります。

a/x + b/y + c/z = 1
// ↓
a*y*z + b*x*z + c*x*y = x*y*z

下準備

各マスに番号をふっておきます。配列のインデックスに対応します。

f:id:yucatio:20200214232720p:plain

1から9までの数字を格納している配列をnとすると、解く式は以下のように書けます。

n[0]/(n[1] * 10 + n[2]) + n[3]/(n[4] * 10 + n[5]) + n[6]/(n[7] * 10 + n[8]) = 1

コード

/**
 * 配列の順列を列挙するジェネレータ
 */
function* arrayEnumerator(numArr){
  yield [...numArr]
  while(true) {
    // numArr[i] < numArr[i-1] となるiを探す
    const changeIndex1 = numArr.findIndex((value, i , arr) => i >=1 && arr[i-1] > value)
    if (changeIndex1 < 0) {
      break
    }
    const changeNumber1 = numArr[changeIndex1]
    const newOrderArr = numArr.slice(0, changeIndex1)
    // changeNumber1 より下位の桁で、changeNumber1 より大きい数字のうち、最小のものを探す
    const changeNumber2 = Math.min(...newOrderArr.filter(value => value > changeNumber1))
    const changeIndex2 = newOrderArr.indexOf(changeNumber2)
    // changeNumber1とchangeNumber2入れ替える
    // 下位桁はreverseする
    newOrderArr[changeIndex2] = changeNumber1
    numArr = [...newOrderArr.reverse(), changeNumber2, ...numArr.slice(changeIndex1 + 1)]
    yield [...numArr]
  }
}


const enumerator = arrayEnumerator([9, 8, 7, 6, 5, 4, 3, 2, 1])

for(let n of enumerator){
  // denominators(分母)
  const denomi = [10 * n[1] + n[2], 10 * n[4] + n[5], 10 * n[7] + n[8]]
  // 左辺
  const left = n[0] * denomi[1] * denomi[2] + n[3] * denomi[0] * denomi[2] + n[6] * denomi[0] * denomi[1]
  // 右辺
  const right = denomi.reduce((acc, cur) => acc * cur , 1)
  if (left === right) {
    console.log(`${n[0]}/${n[1]}${n[2]} + ${n[3]}/${n[4]}${n[5]} + ${n[6]}/${n[7]}${n[8]} equals to 1`)
    break
  }
}

あとがき

急いで書いたので、変数名が微妙になってしまいました。

2020-02-07

JavaScriptでPython風のzip_longest関数を実装する

JavaScript

こちらの記事でPython風のzip関数を実装しました。

yucatio.hatenablog.com

今回はzip_longest関数を作成します。以下のように、各配列の同じインデックスの要素をまとめます。

const a1 = [1, 2, 3]
const a2 = ["Jan", "Feb", "Mar"]
const a3 = ["Garnet", "Amethyst", "Aquamarine"]

zip_longest(a1, a2, a3)
#=> [[1, "Jan", "Garnet"], [2, "Feb", "Amethyst"],  [3, "Mar", "Aquamarine"]]

各配列の長さが異なる場合には、一番長い配列の長さになります。未定義値はundefinedになります。

const a1 = [1, 2, 3, 4]
const a2 = ["Jan", "Feb", "Mar", "Apr", "May"]
const a3 = ["Garnet", "Amethyst", "Aquamarine"]

zip_longest(a1, a2, a3)
#=> [[1, "Jan", "Garnet"], [2, "Feb", "Amethyst"],  [3, "Mar", "Aquamarine"], [4, "Apr", undefined], [undefined, "May", undefined]]

zip_longest関数本体

zip_longest関数の実装です。

const zip_longest = (...arrays) => {
  const length = Math.max(...(arrays.map(arr => arr.length)))
  return new Array(length).fill().map((_, i) => arrays.map(arr => arr[i]))
}

コードの解説

ほとんどzip関数の解説と同じです。

まず、関数の定義の部分を解説します。レスト構文を使用して、引数全てをarraysに格納します。

const zip_longest = (...arrays) => {

}

例えば、

const a1 = [1, 2, 3, 4]
const a2 = ["Jan", "Feb", "Mar", "Apr", "May"]
const a3 = ["Garnet", "Amethyst", "Aquamarine"]

zip_longest(a1, a2, a3)

と呼び出したとき、arraysは

[
  [1, 2, 3, 4],
  ["Jan", "Feb", "Mar", "Apr", "May"],
  ["Garnet", "Amethyst", "Aquamarine"]
]

です。以下、引数にこの配列を渡したときの動作を説明します。

zip_longest関数では、一番長い配列の長さに合わせるので、まず一番長い配列の長さを求めます。

まず、各配列の長さを、求めます。

const zip_longest = (...arrays) => {
  arrays.map(arr => arr.length)
  #=> [4, 5, 3]
}

この中の最大値は、Math.maxとスプレッド演算子を使用して、以下のように書けます。

const zip_longest = (...arrays) => {
  const length = Math.max(...(arrays.map(arr => arr.length)))
  #=> const length = Math.max(...[4, 5, 3])
  #=> const length = Math.max(4, 5, 3)
  #=> const length = 5
}

5回繰り返すので、new Array(length).fill().map((_, i) => i)の構文を使用します。

const zip_longest = (...arrays) => {
  const length = Math.max(...(arrays.map(arr => arr.length)))
  new Array(length).fill().map((_, i) => i))
  #=> [0, 1, 2, 3, 4]
}

fillをはさむ理由については、こちらの記事をご覧ください。

yucatio.hatenablog.com

各配列のi番目の要素は、

arrays.map(arr => arr[i])

で取得することができます。よくわからない場合は、iではなく、0、1、2など具体的な数字で考えるとよいです。例えば、各配列の0番目の要素は、

arrays.map(arr => arr[0])
#=> [1, "Jan", "Garnet"]

です。

これをmapに渡す関数の戻り値にします。

JavaScriptの場合、配列の長さより大きいインデックスを指定した場合はundefinedになります。

const zip_longest = (...arrays) => {
  const length = Math.max(...(arrays.map(arr => arr.length)))
  return new Array(length).fill().map((_, i) => arrays.map(arr => arr[i]))
  #=> [[1, "Jan", "Garnet"], [2, "Feb", "Amethyst"],  [3, "Mar", "Aquamarine"], [4, "Apr", undefined], [undefined, "May", undefined]]
}

以上でzip_longest関数の完成です。

補足的な話題はzip関数の方の記事に記載していますので、あわせてご覧ください。

yucatio.hatenablog.com

2020-02-06

JavaScriptでPython風のzip関数を実装する

JavaScript

JavaScriptにzip関数がなかったので実装してみました。以下のように、各配列の同じインデックスの要素をまとめます。

const a1 = [1, 2, 3]
const a2 = ["Jan", "Feb", "Mar"]
const a3 = ["Garnet", "Amethyst", "Aquamarine"]

zip(a1, a2, a3)
#=> [[1, "Jan", "Garnet"], [2, "Feb", "Amethyst"],  [3, "Mar", "Aquamarine"]]

各配列の長さが異なる場合には、一番短い配列の長さに切り詰められます。

const a1 = [1, 2, 3, 4]
const a2 = ["Jan", "Feb", "Mar", "Apr", "May"]
const a3 = ["Garnet", "Amethyst", "Aquamarine"]

zip(a1, a2, a3)
#=> [[1, "Jan", "Garnet"], [2, "Feb", "Amethyst"],  [3, "Mar", "Aquamarine"]]

zip関数

zip関数の実装です。

const zip = (...arrays) => {
  const length = Math.min(...(arrays.map(arr => arr.length)))
  return new Array(length).fill().map((_, i) => arrays.map(arr => arr[i]))
}

コードの解説

まず、関数の定義の部分を解説します。レスト構文を使用して、引数全てをarraysに格納します。

const zip = (...arrays) => {

}

例えば、

const a1 = [1, 2, 3, 4]
const a2 = ["Jan", "Feb", "Mar", "Apr", "May"]
const a3 = ["Garnet", "Amethyst", "Aquamarine"]

zip(a1, a2, a3)

と呼び出したとき、arraysは

[
  [1, 2, 3, 4],
  ["Jan", "Feb", "Mar", "Apr", "May"],
  ["Garnet", "Amethyst", "Aquamarine"]
]

です。以下、引数にこの配列を渡したときの動作を説明します。

次に、各配列の長さを求めます。

const zip = (...arrays) => {
  arrays.map(arr => arr.length)
  #=> [4, 5, 3]
}

この中の最小値は、Math.minとスプレッド演算子を使用して、以下のように書けます。

const zip = (...arrays) => {
  const length = Math.min(...(arrays.map(arr => arr.length)))
  #=> const length = Math.min(...[4, 5, 3])
  #=> const length = Math.min(4, 5, 3)
  #=> const length = 3
}

3回繰り返すので、new Array(length).fill().map((_, i) => i)の構文を使用します。

const zip = (...arrays) => {
  const length = Math.min(...(arrays.map(arr => arr.length)))
  new Array(length).fill().map((_, i) => i))
  #=> [0, 1, 2]
}

fillをはさむ理由については、こちらの記事をご覧ください。

yucatio.hatenablog.com

各配列のi番目の要素は、

arrays.map(arr => arr[i])

で取得することができます。よくわからない場合は、iではなく、0、1、2など具体的な数字で考えるとよいです。例えば、各配列の0番目の要素は、

arrays.map(arr => arr[0])
#=> [1, "Jan", "Garnet"]

です。

これをmapに渡す関数の戻り値にします。

const zip = (...arrays) => {
  const length = Math.min(...(arrays.map(arr => arr.length)))
  return new Array(length).fill().map((_, i) => arrays.map(arr => arr[i]))
  #=> [[1, "Jan", "Garnet"], [2, "Feb", "Amethyst"],  [3, "Mar", "Aquamarine"]]
}

以上でzip関数の完成です。

zip_longest

Pythonのzip_longestにあたる関数はMath.minの部分をMath.maxにするだけです。こちらの記事に詳しい動作を載せています。

yucatio.hatenablog.com

イテレータの使用

Pythonではイテレータを使用して配列の要素にアクセスしています。list[i]のようにインデックスを指定してアクセスするよりも、イテレータの方が速いことが期待されるからでしょう。 (参考: 組み込み関数 — Python 3.8.1 ドキュメント )

JavaScriptにもイテレータがあるのでそちらを利用しようかと思いましたが、あまり慣れている書き方ではないので今回は見送りました。 ( 参考:Array.prototype.values() - JavaScript | MDN)

rubyのzipメソッド

rubyにもzipメソッドがあり、似た動きをするのですが、こちらはArrayクラスのインスタンスメソッドです。こちらはレシーバの要素数が作成後の配列の長さになります。

Array#zip (Ruby 2.7.0 リファレンスマニュアル)

[1,2,3].zip([4,5,6], [7,8,9])
# => [[1, 4, 7], [2, 5, 8], [3, 6, 9]]

2020-01-17

プログラミングで初学者のときにつまづいたこと

自己紹介

プログラミングでつまづいてきたことというブログ記事を見たので、私も書いてみます。

satoru-takeuchi.hatenablog.com

mizchi.hatenablog.com

自己紹介

記事をリンクしたお2人と違って大したプログラマではないですが、システムエンジニアとして働いて10年経ってみて今の仕事が向いていると思っているところです。

大学でC言語とJavaを習って、仕事はWeb系で主にJavaを使用しています。

以下、つまづいたことです。だいたい古いのから新しいものになっています。

代入文

a = 1
b = 2
c = a + b

でcが3になるのは分かったのだが、

a = a + 1

これを見て、"左右が等しくない。"と混乱し、そこで思考が止まってしまった。半年後くらいに代入文という言葉を覚え、上記は"a + 1を計算した結果をaに入れる"だということが分かった (が慣れるまでにはもう少しかかった)。

アルゴリズム

プログラムそれ自体よりもアルゴリズムでつまづく(大学の授業で習った。言語はC言語。)

バブルソートわからない。わかってもコードに落とし込めない。2重ループが難しすぎる。

こんなに便利な世の中なのに、並び替えをするのにいちいち自前でプログラミングをしなければいけないなんて、どうなっているのだと思った。 (色々と認識が間違っていた)

Java

オブジェクト、インスタンス、クラス

用語の説明を何度読んでも理解ができない。他にもとにかく馴染みのないカタカナ語が多すぎて嫌になった。

あるとき、C言語の構造体に関数を足したのがクラスだと気づきそこから理解が進んだ。が、C言語を習っていなかったらと思うと震える。

Javaのオブジェクト指向 (継承、ポリモーフィズム、カプセル化)

惑星クラスを拡張したのが、水星クラス、金星クラス、土星クラスとか、犬クラスだったら"ワン"と鳴いて、猫クラスだったら"ミャー"と鳴くとか、何に使うかがわからなかった。値の隠蔽(カプセル化)が重要という割に、setterで値を操作できているではないか、と思った。

理解できるようになったのは、Javaのデザインパターンを読んでから。

[商品価格に関しましては、リンクが作成された時点と現時点で情報が変更されている場合がございます。]

Java言語で学ぶデザインパターン入門増補改訂版 [ 結城浩 ]
価格：4180円（税込、送料無料) (2020/1/17時点)

楽天で購入

ちなみに"オブジェクト指向とは何か"はこちらの記事でWindows95を開発した中島聡さんの言葉を引用しています。

yucatio.hatenablog.com

インターフェース

インターフェースも何に使うか長年の疑問だった。実装がないとは何の役にも立たないのではないか。

確かこの本だったと思うけど、"例えば、自動販売機、外側に見える部分がちゃんと仕様通りに動いていれば、中に人が入っていて、手でジュースを出してもよい。自動販売機の、外から見える部分がインターフェース、中の機械とかが実装"、といったことがイラスト付きで書いてあって、その図がシュールで印象に残った。この例からなんとなく理解し始めたように思う。

ウチのシステムはなぜ使えない SEとユーザの失敗学（光文社新書） [ 岡嶋裕史 ]
価格：814円（税込、送料無料) (2020/1/18時点)

楽天で購入

その後、"仕様と実装を分けて考える"ということができるようになってきたのでインターフェースの使い所もはっきりしてきた。

Rubyのmap関数

array.map {|i| i * 2 }

で、なぜ各配列の値が2倍されるのか分からなかった。Javaしかほぼやってこなかったので、変換後の配列が定義されていないことが不思議だった。

JavaのMapとRubyのmapは全くの別物ということに思い当たったのと(JavaのMapはRubyのhash)、とりあえずJavaでの記法(for文を使うもの)と対比させて覚えた。

プログラミング以外でのつまづきも多い

リンク先での記事でも「オブジェクト」「スタック」「ヒープ」が多義語で分かりにくかったとの記載があったが、自分の場合は「ドメイン」「インスタンス」が多義語で混乱した。がこれはプログラミングではないもの(プログラミングの周辺知識ではあるが)も含まれているので機会があれば書きたい。

最近はプログラミング言語それ自体というより、周辺のツールで使用される概念や用語の理解に苦労する。最近だとDockerの用語の理解でつまづいた。

あとがき

書きながら、プログラム始めたばかりのころ全然コードが動かなくて吐きそうになったのを思い出しました。

とりあえず私から言えることは、Javaは最初に学ぶような言語ではないということです。

2020-01-13

eclipseのJavadocの警告設定の各設定値の意味【後編】

eclipse

Javadocの記述が不完全なときに警告を出そうとして、どのような設定があるか調べたメモです。

チーム開発でJavadocをどの程度書くかどうか、意識を統一するのにこの記事をご活用いただければと思います。

前編の記事
未指定の Javadoc タグ
未指定の Javadoc コメント
- メンバーの可視性を次のように設定
- オーバーライドしたメソッドの実装を無視
環境
あとがき
参考サイト

前編の記事

yucatio.hatenablog.com

未指定の Javadoc タグ

"未指定の Javadoc タグ"をONにすると、メソッドに定義されていてJavadocに記載されていないパラメータや例外などがある場合に警告を出します。

f:id:yucatio:20200113175535p:plain

メンバーの可視性を次のように設定

設定した可視性以上のJavadocのみ、"未指定の Javadoc タグ"の警告を出します。

オーバーライドしたメソッドの実装を無視

Javaでは、オーバーライドしたメソッドのJavadocは、子クラスの内容で親クラスの内容を上書きした内容となります。以下の例では、子クラスでdescriptionと変数xの記述を上書きし、他のparamとreturnについては、親クラスの記述が引き継がれています。

f:id:yucatio:20200113180300p:plain

"オーバーライドしたメソッドの実装を無視"をOFFにすると、オーバーライドしたメソッドであっても、未指定の Javadoc タグがある場合には警告を出します。

f:id:yucatio:20200113180008p:plain

ただし、@Overrideアノテーションが付いている場合、警告は出ません。

f:id:yucatio:20200113180021p:plain

詳しい仕様と仕様が策定された経緯につきましてはこちらをご覧ください。

6.15 complains about missing @return tag in a overridden method · Issue #2869 · checkstyle/checkstyle · GitHub

メソッド型パラメータを無視

メソッド型パラメータとは、ジェネリックメソッドにおいて、メソッドの戻り値の型の直前に書かれた<T>などの型の仮型パラメータのことです。 (参考: Java ジェネリクス（クラス、メソッドを定義する） - Qiita )

"メソッド型パラメータを無視"がONのときは、この<T>のためのJavadoc(@param <T>)がなくても警告を出しません。

OFFにすると、警告を出します↓

f:id:yucatio:20200113195747p:plain

未指定の Javadoc コメント

"未指定の Javadoc コメント"をONにすると、Javadocが記載されていない場合に警告を出します。

"メンバーの可視性を次のように設定"を"Protected"にした時の表示です↓

f:id:yucatio:20200113215408p:plain

メンバーの可視性を次のように設定

設定した可視性以上のJavadocのみ、警告を出します。

オーバーライドしたメソッドの実装を無視

"オーバーライドしたメソッドの実装を無視"をONにすると、オーバーライドしたメソッドにJavadocが無くても警告を出しません。

オーバーライドしたメソッドは、Javaでは親クラスのJavadocが使用されるため、指定しなくても問題ないことが多いかもしれません。

"オーバーライドしたメソッドの実装を無視"をOFFにすると、オーバーライドしたメソッドにも警告を出します。

f:id:yucatio:20200113220027p:plain

"未指定の Javadoc タグ > オーバーライドしたメソッドの実装を無視" の設定とは違い、こちらは@Overrideアノテーションのあるなしでの挙動の違いはありません。

オーバーライドしたメソッドに親と同じ内容のJavadocを書ときは、{@inheritDoc}タグを使うと便利です。

  /**
   * {@inheritDoc}
   */
  @Override
  public int calcA(int x, int y, int z) {
    return x + y + z + 1;
  }

参考: オーバーライドしたメソッドのJavadoc - 気付いたとき、気が向いたとき。by ykhr

環境

eclipse 2019-12 (https://mergedoc.osdn.jp/ からPleiades All in One Eclipse(Mac 64 bit/Full Edition/Java)をダウンロードしました)

あとがき

"未指定の Javadoc タグ > オーバーライドしたメソッドの実装を無視" の設定が自分の想定と違った動作をしたので意外と苦戦しました。

参考サイト

Java コンパイラーの Javadoc 設定 - IBM Knowledge Center

2020-01-12

eclipseのJavadocの警告設定の各設定値の意味【前編】

eclipse

Javadocの記述が不完全なときに警告を出そうとして、どのような設定があるか調べたメモです。

チーム開発で、Javadocをどの程度書くかどうか、意識を統一するのにこの記事をご活用いただければと思います。

Javadocの警告設定
Javadocコメントを処理
誤った形式の Javadoc コメント
後編
環境
参考サイト

Javadocの警告設定

Javadocの書き方がよくないときに警告を出す設定の場所は、 設定 > Java > コンパイラー > Javadoc です。

f:id:yucatio:20200112222657p:plain

Javadocコメントを処理

"Javadocコメントを処理"をONにすると、Javadocとメソッドが連携されます。変数名を選択したときにJavadocのparamの変数名もハイライトされます。

ONのとき↓

f:id:yucatio:20200112223145p:plain

OFFのとき↓

f:id:yucatio:20200112223156p:plain

また、ONにすると、変数のリネーム時にJavadocのparamの変数も同時に変更されます。

ONのとき↓

f:id:yucatio:20200112223411p:plain

OFFのとき↓

f:id:yucatio:20200112223421p:plain

誤った形式の Javadoc コメント

"誤った形式の Javadoc コメント"をONにすると、波かっこが閉じていないときなどに警告を出します。

f:id:yucatio:20200112223630p:plain

メンバーの可視性を次のように設定

設定した可視性以上のJavadocのみ、警告を出します。

可視性をProtectedにしたときに、PublicとProtedtedメソッドのにのみ警告が出て、パッケージとPrivateのメソッドに警告は出ません↓(タグ引数の検証をONにしたときの警告)

f:id:yucatio:20200112224059p:plain

タグ引数の検証 (@param, @throws, @exceptions, @see, @link)

"タグ引数の検証"をONにすると、@param, @throws, @exceptions, @see, @linkに指定されたクラスやメソッドが存在しないときに警告を出します。

min1という引数はメソッドに存在しないため、警告が出ます↓

f:id:yucatio:20200113142031p:plain

f:id:yucatio:20200113141532p:plain

Nowhere.nomthodという存在しないクラスとメソッドを参照しているので警告が出ます↓

f:id:yucatio:20200112224211p:plain

不可視参照をレポート

"不可視参照をレポート"をONにすると、不可視なメソッドなどを参照をしたときに警告を出します。不可視な参照とは、例えば他のクラスのprivateなメソッドや定数です。

他のクラス(SamplePrivateクラス)のprivateな定数(DEFAULT_NAME)を参照しているので、警告が出ます↓

f:id:yucatio:20200112224444p:plain

使用すべきでない参照をレポート

"使用すべきでない参照をレポート"をONにすると、非推奨(Deprecated)となったメソッドや変数を参照したときに警告します。

f:id:yucatio:20200112224653p:plain

タグ記述の欠落

"タグ記述の欠落"の設定では、 @param 変数名や@returnなどのタグのあとの記述が無いときに警告を出します。

@return タグの検証ではその名の通り、@returnタグの後に何も書かれていなければ警告を出します。その他のタグの後には何も書かれていなくても警告を出しません。

f:id:yucatio:20200112225611p:plain

全ての標準タグを検証にすると、全ての標準タグにおいて、タグの記述がない場合に警告を出します。標準タグとは javadoc - Java API ドキュメントジェネレータに記載されているタグです。

f:id:yucatio:20200112225624p:plain

後編

長くなったので続きます。

yucatio.hatenablog.com

環境

eclipse 2019-12 (https://mergedoc.osdn.jp/ からPleiades All in One Eclipse(Mac 64 bit/Full Edition/Java)をダウンロードしました)

参考サイト

Java コンパイラーの Javadoc 設定 - IBM Knowledge Center