coding conventions, documentation, testing

2008-03-01
2013-04-26
  • Martin Zibricky

    Martin Zibricky - 2008-03-01

    What coding style should we use?
    I seems we will use programming language python. Should we follow the standard python's coding conventions http://www.python.org/dev/peps/pep-0008 ?

    What about Automatic documentation generation (something like javadoc)? Should we use something like:
    - Doxygen http://www.doxygen.org
    - Epydoc http://epydoc.sourceforge.net
    - Pydoc
    ?

    Should we use a unit testing framework like Pyunit?

     
    • Jochen Weiss

      Jochen Weiss - 2008-03-30

      I vote for using PyUnit as testing framework
      http://pyunit.sourceforge.net/pyunit.html
      No code should be accepted without a unit tests.

       
      • Martin Zibricky

        Martin Zibricky - 2008-03-30

        Could you please prepare some examples and describe or collects some resources how to work with PyUnit? I would prepare the place in wiki and svn where you could put your notes and samples.
        - this could help more people than only me

         
        • Jochen Weiss

          Jochen Weiss - 2008-03-30

          I only know what's in the link I've posted. ( http://pyunit.sourceforge.net/pyunit.html\)

          I read that it is similar to JUnit. And this is a really framework.
          As I told you already, I have to get familiar with Python first. But it's seems to me that the switch from Java is not so hard as expected :-).
          I'm gonna try PyUnit the next days and will report my experience.

           
    • Magnon Damant

      Magnon Damant - 2008-04-03

      Yes I think we should follow the
      "standard python coding conventions".

      It might be good to make a summary of
      this convention to put on the wiki.

      -Magnon

       
    • Martin Zibricky

      Martin Zibricky - 2008-10-22

      Hi every one.

      I've summarized some points about coding style:

      http://changingsong.sourceforge.net/wiki/Coding_Style

      And created one examle script, basend on this style:

      http://changingsong.svn.sourceforge.net/viewvc/changingsong/trunk/samples/xml_parser/minidom/benchmark.py?view=markup

      What do you think about it?
      Is it acceptable?

       
    • celsowm

      celsowm - 2008-10-23

      Good! I'm still learning python, and I will use these patterns over the next codes.

       

Log in to post a comment.

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:

JavaScript is required for this form.





No, thanks