I recently started coding on Java, and I often see single <p> tags used to separate lines. But for my purposes, I don't actually want to make 'paragraphs', but just linebreaks, so docs wouldn't be so terrible to read. Are <br> tags tolerable?
Finally, I came up with 3 styles of docs suitable for the project. What would I get killed for?
Looks nice inside the code and bad in doc viewing
/** * <p> Does highly important adorable things. </p> * <p> Not only helping fields in being suitable * for stack overflowing, but also loves cats. </p> * <p> Please do not call while there are * some elephants in the main class. </p> */Looks terrible inside the code and doc viewing
/** * Does highly important adorable things. <p> * Not only helping fields in being suitable * for stack overflowing, but also loves cats. <p> * Please do not call while there are * some elephants in the main class. */Looks fine inside the code and doc viewing
/** * Does highly important adorable things. <br> * Not only helping fields in being suitable * for stack overflowing, but also loves cats. <br> * Please do not call while there are * some elephants in the main class. */