We have moved to https://dokuwiki.librecad.org/
Lots of content was already moved to the new wiki, but there is still work to do. If you want to contribute, please register a new account at https://dokuwiki.librecad.org/
This wiki will be kept for a while to keep search engine results valid. Moved sites may be deleted here in future.
Difference between revisions of "LibreCAD 3 - LibreCAD 3 - code style"
From LibreCAD wiki
R. van Twisk (Talk | contribs) |
R. van Twisk (Talk | contribs) |
||
Line 20: | Line 20: | ||
document->entityByID(...); // return null if a entry does not exists | document->entityByID(...); // return null if a entry does not exists | ||
</pre> | </pre> | ||
+ | |||
+ | |||
+ | '''hide shared_ptr behind a typedef:''' | ||
+ | |||
+ | <pre> | ||
+ | typedef std::shared_ptr<Circle> Circle_SPtr; | ||
+ | typedef std::shared_ptr<const Circle> Circle_CSPtr; | ||
+ | </pre> | ||
+ | |||
+ | This so we can 'shorten' our shred pointers, example: | ||
+ | |||
+ | <pre> | ||
+ | std::list<std::shared_ptr<const Circle>> myListLong; // Less readble | ||
+ | std::list<Circle_CSPtr> myListReadable; // better readable | ||
+ | </pre> | ||
+ | |||
'''Shared pointer passing:''' | '''Shared pointer passing:''' |
Revision as of 23:59, 15 May 2014
Code style guide
Accessor naming:
use foo->layer()
instead of
foo->getLayer();
Exceptions:
Only throw exceptions in rare situations that are effectively unreasonable.
For example:
document->entityByID(...); // return null if a entry does not exists
hide shared_ptr behind a typedef:
typedef std::shared_ptr<Circle> Circle_SPtr; typedef std::shared_ptr<const Circle> Circle_CSPtr;
This so we can 'shorten' our shred pointers, example:
std::list<std::shared_ptr<const Circle>> myListLong; // Less readble std::list<Circle_CSPtr> myListReadable; // better readable
Shared pointer passing:
never pass shared_ptr by reference
Good:
Line::Line(const geo::Coordinate& start, const geo::Coordinate& end, const shared_ptr<Layer> layer) : CADEntity(layer), Vector(start, end) {..}
Bad:
Line::Line(const geo::Coordinate& start, const geo::Coordinate& end, const shared_ptr<Layer> &layer) : CADEntity(layer), Vector(start, end) {..}