What are the Slack Archives?

It’s a history of our time together in the Slack Community! There’s a ton of knowledge in here, so feel free to search through the archives for a possible answer to your question.

Because this space is not active, you won’t be able to create a new post or comment here. If you have a question or want to start a discussion about something, head over to our categories and pick one to post in! You can always refer back to a post from Slack Archives if needed; just copy the link to use it as a reference..

Guten Morgen. Es gibt in Spryker bestimmt Best Practices, was die Pflege von DocBlocks angeht. Gibt

UQS4LDZU7
UQS4LDZU7 Posts: 182 🧑🏻‍🚀 - Cadet
edited March 2020 in Help

Guten Morgen. Es gibt in Spryker bestimmt Best Practices, was die Pflege von DocBlocks angeht. Gibt es eine klare Empfehlung, wann @api bzw @inheritdoc Annotationen zu schreiben sind und wo?

Comments

  • UQS4LDZU7
    UQS4LDZU7 Posts: 182 🧑🏻‍🚀 - Cadet
    edited March 2020

    Sorry, English: Are there any suggestions of Spryker concerning the documentation of code, for instance, where and when to put @api / @inheritdoc annotations? Thank you!

  • Unknown
    Unknown

    Hey Alexey! Facades, Clients, Services and plugins are public api. @inheritDoc is used to inherit public api interfaces specification. Facades as an example.

  • UQS4LDZU7
    UQS4LDZU7 Posts: 182 🧑🏻‍🚀 - Cadet

    Thank you, Aleksey!

  • Serhii Chepela
    Serhii Chepela Sprykee Posts: 49 🧑🏻‍🚀 - Cadet

    Also query containers and plugins. But query containers is a bit old concept and we avoid to use it.

  • Andriy Netseplyayev
    Andriy Netseplyayev Sprykee Posts: 519 🧑🏻‍🚀 - Cadet

    I would not forget Glue’s “RestApiResource”-s, as well

  • Stanislav Matveyev
    Stanislav Matveyev Sprykee Posts: 211 🧑🏻‍🚀 - Cadet

    Controllers are also public api

  • Unknown
    Unknown

    But those are not market with @api tag

  • Serhii Chepela
    Serhii Chepela Sprykee Posts: 49 🧑🏻‍🚀 - Cadet

    Yes, but we usually don’t mark it with api tag 🙂

Categories