If your library is seeming big and gnarly to you, it will probably be really hard to digest for someone who is seeing it for the first time.
Creating a refactored hierarchy can go a long way toward helping someone make sense of your code and gives them a nice warm feeling that each component is a encapsulated piece, free of action at a distance in all the other code.
It is true that that the build process becomes a little more complex, but once the makefile/autoconf scripts are written, it becomes simple for the user. Personally, if I see a C lib with an understandable layout and good docs, I'll live with whatever build process that is around. But the simplest build process imaginable won't compensate for a hard to understand library structure.
I think an excellent exampe of this is the Qt library. It has a funky build system, complete with its own moc preprocessor, but the routines are arranged and described so nicely, I can deal with signals, slots, and mocs.
Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
Read Where should I post X? if you're not absolutely sure you're posting in the right place.
Please read these before you post! —
Posts may use any of the Perl Monks Approved HTML tags:
- a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
| |
For: |
|
Use: |
| & | | & |
| < | | < |
| > | | > |
| [ | | [ |
| ] | | ] |
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.