Menu

Documentation quality

Michael
2014-01-31
2014-02-08
  • Michael

    Michael - 2014-01-31

    I wrote a basic documentation on russian and a bit part on english.
    So there we need discuss

    1. Is it clear all rules connected with working with repo.
    2. Code style.

    However we have almost all documentation on russian Nevertheless we need to translate part of it into english.
    Awaiting replays.

    P.S. Sorry for bad english.

     
  • Edd Layer

    Edd Layer - 2014-02-04

    Mike where I can download this documentation?

     
  • Michael

    Michael - 2014-02-04

    Hi, Edd. If you use Windows install tortoise hg, you have 2 ways to access to repository:
    1) if you have generated public part of SSH key
    2) via https
    the second way is easier
    so in windows explorer select -> Tortoise Hg -> Clone
    choose as source https://joporez@hg.code.sf.net/p/easysockets/code
    instead as joporez you must write you id, you code see it here: https://sourceforge.net/p/easysockets/code/

     
  • Alexander

    Alexander - 2014-02-07

    I suggest (not insist) to add the following corrections to our code style guidline:

    using typename instead of class keyword in templates;
    replacing Exception suffix with Error in exception classes;
    refusing .c++ and .hpp file extensions;
    using line-continuation character (backslash) instead of duplicating "" in a new line;

     

    Last edit: Alexander 2014-02-07
  • Michael

    Michael - 2014-02-08

    Hi, Alex.
    1) I suppose that typename would be better.
    2) Actually i don't think that Error is more suitable for Exception classes. We simply could misunderstand when we have logic error, or operation error or where we generate and catch Exception. There is a common practice in Java and C# to call Exception classes with suffix Exception, i.e: ArgumentException, NullReferenceException.
    3) I suggest to use .h extension for headers, .c extension for C functions layers and .cpp for C++ code (this is a common practice).
    4) About backshashes : I agree.

     
  • Alexander

    Alexander - 2014-02-08

    Hi Mike,
    choice of suffix is up to you, but let me explain the correction I propose.
    The thing is, Error is kinda standard "last name" for the exception classes derived from std::exception and its subclasses: std::logic_error, std::runtime_error, std::system_error, although it's not strict as directly derived std::bad_alloc, std::bad_cast and so on have no suffix at all. I assume the reason for such a naming convention is that Exceptions were originally invented as the replacement for or at least the good alternative to using "ordinary" error handling (error codes).

     

Log in to post a comment.

MongoDB Logo MongoDB