Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional metadata for Hexagonal Architecture's @Ports and @Adapters #79

Closed
odrotbohm opened this issue May 16, 2022 · 0 comments
Closed
Assignees
Labels
module: architecture Architectural style related support type: enhancement New feature or request
Milestone

Comments

@odrotbohm
Copy link
Member

For documentation purposes, it would be nice to be able to declare a port or adapter's logical name and description in the annotation. This could be used to place human-readable flavors of their domain semantics right with the code that could be extracted into developer documentation.

  • name() – defaults to the package or type name.
  • description() – defaults to the Javadoc of either the package or type

This especially becomes interesting if there's not a 1:1 mapping between, for example, port and type. Using the same port names would allow them to be grouped and displayed in docs. Assume some API / SPI split of some application feature that could use different packages to place the corresponding types in them but define a single place (the @(Primary|Secondary)Port annotation on the package-info.java) to define a human-readable description of each of them.

Follow-up of #71.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module: architecture Architectural style related support type: enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants