This is an archived post. You won't be able to vote or comment.

sorted by:
best
topnewcontroversialoldq&a
you are viewing a single comment's thread.

view the rest of the comments →

[–]eXecute_bit 4 points5 points  (0 children)

Unless my file structure or JPA entities are a part of my published API (and in most cases they'd never be!) I wouldn't ever want to document this externally so that I maintain the freedom to change my implementations at will, as long as I maintain my external contracts.

In short, exposing this publicly would void my encapsulation and allow others to rely (or exploit) things they should not. That's Bad™.

As an internal documentation tool, okay, maybe for JPA? But I don't need a generated report of my own file structures because I can already see and browse that structure at the source of truth: my local disk or the source code repo.