Roland, We have a similar problem in the bioinformatics world, where a field like "id" could mean an ID from a specific database, an accession (an alphanumeric ID similar to a database ID). One way around this is to use semantic annotations for fields. Here's an example. http://aspenbio.wordpress.com/2011/01/20/biogroovy-and-the-semantic-web/
Cheers, Mark On Tue, Apr 16, 2013 at 12:24 PM, Roland Tepp <[email protected]> wrote: > While I generally agree that good code needs no comments, as an insider it > is sometimes difficult to judge wether some piece of code or a method name > satisfies the requirements of obviousness. > > Particularily bad is the documentation of the domain model objects and > methods. Quite often in my experience, the domain model is anemic and only > acts as a dumb record holder with simple getter and setter methods. > > While it seems to be obvious at first glance, what the method named > getName() does, it is much less obvious what the name field means for the > business. Is it merely a human readable label for the object? Is it used to > identify the object in some subsystem? What is the format of the name (i.e. > does it allow spaces numbers or punctuation) etc? > > And that is just questions I get when I see the propert called "name" in > the model. What if the property is called "total" or "susg". > > -- > You received this message because you are subscribed to the Google Groups > "Java Posse" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To post to this group, send email to [email protected]. > Visit this group at http://groups.google.com/group/javaposse?hl=en. > For more options, visit https://groups.google.com/groups/opt_out. > > > -- You received this message because you are subscribed to the Google Groups "Java Posse" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/javaposse?hl=en. For more options, visit https://groups.google.com/groups/opt_out.
