Spark использует специальный плагин Jekyll для создания своей документации, который называется include_example.rb
. Это позволяет им использовать тег include_example
в своих источниках Markdown для включения файла из репозитория.
Плагин содержит следующее описание:
# Select lines according to labels in code. Currently we use "$example on$" and "$example off$"
# as labels. Note that code blocks identified by the labels should not overlap.
Таким образом , эти комментарии предназначены для того, чтобы они могли лучше автоматически создавать свою документацию.
Файл, который вы указали в вопросе, включен в getting-started.md . Через {% include_example create_df scala/org/apache/spark/examples/sql/SparkSQLExample.scala %}.
Вы можете увидеть, как это выглядит полностью отрисованным в Начало работы - Документация Spark 3.0.0 .
Как видите, они используют эти теги для удаления нерелевантной информации / шаблона каждого языка и отображать только c бит. Различные метки позволяют им выбирать разные биты файла.