code-documentation

codestyle; put javadoc before or after annotation?

by

I know that it isn’t the most vital of issues, but I just realised that I can put the javadoc comment block before or after the annotation. What would we want to adopt as a coding standard? /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired /** … Read more

JSDoc: Return object structure

by

How can I tell JSDoc about the structure of an object that is returned. I have found the @return {{field1: type, field2: type, …}} description syntax and tried it: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or a jQuery … Read more