Блог

Я хотел бы добавить документацию в исходном коде, не привязанную к какому-либо конкретному классу или методу Kotlin, это похоже на концептуальную документацию высокого уровня.

Я хотел бы сохранить ее в исходном файле Kotlin, рядом с тем, что она описывает.

В идеале я хотел бы иметь возможность записать это как:

 ...
doc(
  title = "Some title",
  text  = "Some text"
)
...
  

Но это невозможно, так как Kotlin не разрешает вызовы верхнего уровня, я также пытался использовать аннотации, но это также запрещено без привязки чего-либо к нему.

 @Doc(
  title = "Some title",
  text  = "Some text"
)
  

Итак, приведенный ниже код работает, но выглядит не очень красиво. Есть ли что-нибудь получше?

 @Doc private val doc1 = doc(
  title = "Some title",
  text  = "Some text"
)
  

Или, может быть

 @Doc(
  title = "Some title",
  text  = "Some text"
) val tmp = 0