On Apr 21, 2009, at 11:34 PM, Zach Welch wrote:
Hi all,This trivial patch adds comment rulers to aid navigation. It will applycleanly on top of the previous patch to factor jlink_execute_queue.This is my last cosmetic improvement for now, as I have started to pullout the pieces from Jeff's patches. Now the fun(ctional) work begins. Cheers, Zach<openocd-add-jlink-section- markers.patch>_______________________________________________Openocd-development mailing list [email protected] https://lists.berlios.de/mailman/listinfo/openocd-development
I'm going to hold off on this one. We don't have an established standard for comment-based navigational aids. I've used a few different styles over the years and each project seems to have a different preferred form. I'm a fan of consistency, so I'd like to pick a form and stick with it. I'd also like to set some guidelines:
- Only use navigational comments (rulers) to break up a large file into related blocks of functions (not individual functions) - Rulers between a #define block, a type definitions block, and a prototypes block are encouraged - The line immediately after a ruler should be a comment containing a description of the next block
This makes them not only a visual cue but also informative. FWIW, my preference is to use: /* -------------------------------------------------------- */I also like using "#pragma mark -" if your editor supports it, but that seems to be a very hit or miss item.
-- Rick Altherr [email protected]"He said he hadn't had a byte in three days. I had a short, so I split it with him."
-- Unsigned
smime.p7s
Description: S/MIME cryptographic signature
_______________________________________________ Openocd-development mailing list [email protected] https://lists.berlios.de/mailman/listinfo/openocd-development
