1. 概要

このチュートリアルでは、Jenkinsfileでコメントを使用する方法を説明します。 さまざまな種類のコメントとその構文について説明します。

2. Jenkinsfileのコメント

Jenkinsfile の構文はGroovyに基づいているため、コメントにGroovy構文を使用できます。 Pipeline Linterの簡単な例を取り上げて、コメントアウトしてみましょう。

2.1. 単一行コメント

Jenkinsfileの1行のコメントは、Java、C ++、C＃などの一般的な言語で見られるものと同じです。

それらは2つのスラッシュ（ // ）で始まります。 // と行末の間のテキストはコメント化され、Jenkinsfileでは無視されます。

1行のコメントを使用して、基本的なパイプライン定義をコメントアウトしましょう。

//pipeline {
//    agent any
//    stages {
//        stage('Initialize') {
//            steps {
//                echo 'Hello World'
//            }
//        }
//    }
//}

2.2. コメントをブロックする

Jenkinsfile のブロックコメントは、コードのブロックをコメントアウトするために使用されます。 この場合も、パターンはJavaおよびC++に似ています。

ブロックコメントは、スラッシュの後にアスタリスク（/ *）が続き、アスタリスクの後にスラッシュ（* /）が続きます。 開始（/ *）文字と終了（* /）文字が適切な場所に追加され、選択したブロックをコメントとしてマークします。

この例では、ブロックコメントを使用してパイプライン定義をコメントアウトします。

/*
pipeline {
    agent any
    stages {
        stage('Initialize') {
            steps {
                echo 'Placeholder.'
            }
        }
    }
}
*/

2.3. シェルスクリプトのコメント

シェル（sh）セクション内では、コメントにシェルコメント文字ハッシュ（＃）を使用します。

pipeline {
    agent any
    stages {
        stage('Initialize') {
            steps {
                sh '''
                cd myFolder
                # This is a comment in sh & I am changing the directory to myFolder
                '''
            }
        }
    }
}

3. 結論

この短い記事では、Jenkinsfileのさまざまな種類のコメントについて説明しました。 まず、1行のコメントを確認しました。 次に、ブロックコメントの使用方法を確認しました。 最後に、Jenkinsfileのシェルセクション内にコメントを追加する方法を示しました。