Bonne façon de commenter le code. Python

Je lisais PEP8 et quelques questions sur stackoverflow, mais je me demandais à propos des espaces entre les commentaires:

permet de dire que j'ai ce code:

class MyBrowser(QWebPage):
    ''' Settings for the browser.'''

    def __init__(self):
        QWebPage.__init__(self)
        # Specifies whether images are automatically loaded in web pages.
        self.settings().setAttribute(QWebSettings.AutoLoadImages, True)

    def userAgentForUrl(self, url):
        ''' Returns a User Agent that will be seen by the website. '''
        return "Mozilla/5.0 (Windows NT 6.2; WOW64) AppleWebKit/537.15 (KHTML, like Gecko) Chrome/24.0.1295.0 Safari/537.15"

Ce qui est le plus pythonic façon de mettre des lignes vides entre les commentaires et le code réel? Je veux montrer à mon programme de certains experts. Et voulez mon code un aspect plus professionnel.

je pense que votre espacement est bien ... aussi ce qui constitue experts?
Par des experts, je veux dire la gestionnaire d'embauche dans une entreprise
ils peuvent ne pas être des experts.... souvent les employeurs sont disposés à la moisissure de vous ce qu'ils veulent... ce qu'ils veulent voir, c'est que vous avez une prise sur python concepts et les directeurs d'école ... et que vous êtes au courant de certaines des différences entre compilé vs Interprété etc.

OriginalL'auteur Vor | 2012-12-12

  1. 11

    Je ne sais pas si cela représente la "norme sociale" mais voici Google Python guides de style (comme ils se rapportent à des commentaires). Plus précisément classes:

    class SampleClass(object):
    """Summary of class here.

    Longer class information....
    Longer class information....

    Attributes:
        likes_spam: A boolean indicating if we like SPAM or not.
        eggs: An integer count of the eggs we have laid.
    """

    def __init__(self, likes_spam=False):
        """Inits SampleClass with blah."""
        self.likes_spam = likes_spam
        self.eggs = 0

    def public_method(self):
        """Performs operation blah."""

    OriginalL'auteur Jason Sperske

  2. 2

    En cas de doute, regardez la bibliothèque standard pour un modèle.

    Voici un extrait de la timeit module (écrit par Guido van Rossum lui-même):

    def print_exc(self, file=None):
    """Helper to print a traceback from the timed code.

    Typical use:

        t = Timer(...)       # outside the try/except
        try:
            t.timeit(...)    # or t.repeat(...)
        except:
            t.print_exc()

    The advantage over the standard traceback is that source lines
    in the compiled template will be displayed.

    The optional file argument directs where the traceback is
    sent; it defaults to sys.stderr.
    """
    import linecache, traceback
    if self.src is not None:
        linecache.cache[dummy_src_name] = (len(self.src),
                                           None,
                                           self.src.split("\n"),
                                           dummy_src_name)
    # else the source is already stored somewhere else

    traceback.print_exc(file=file)

    OriginalL'auteur Raymond Hettinger

  3. 2

    De la Zen de Python: "la Lisibilité compte." Quelle que soit votre équipe trouve à être la plus lisible est ce que je ferais.

    en général ,cependant, parfois, de ses que le python de la population(contrairement à vous) trouve plus lisible (je vous ai donné +1 bien que, en général, c'est vrai)
    Je trouve souvent mon code moins lisible sans commentaires, car je sais déjà ce qu'il fait, mais je sens que cela ne signifie pas que je ne devrait pas inclure des commentaires.
    Je ne suis pas d'accord que ce vous préfère, c'est mieux. J'ai travaillé avec des gens qui ont suivi bizarre normes (trois d'espace de l'indentation, par exemple). Ils aimaient leur code. Personne dans le groupe ne pouvais supporter de le regarder.
    TBH j'ai rarement inclure des commentaires dans mon python ... j'utilise l'auto documentation variable/les noms de fonction et qui est souvent suffisant ... cela dit je n'aurais probablement pas présenter mon commentless code ..
    Éventuellement...mais combien d'entre nous réellement le code que le python de la communauté dans son ensemble a vu/plus voir? Si je peux le lire et mes collègues de travail ne sont pas des coliques à moi, je trouve que, pour être suffisant. Et oui, je n'ai jamais rencontré un programmeur qui n'ont pas de parler de son esprit à ses collègues 😀

    OriginalL'auteur brian buck

  4. 0

    Au lieu de donner des extraits de regarder le plus utilisé, disponible à l'aide de sphinx et de comparer la doc pour le code.

    https://docs.python.org/3/library/difflib.html

    https://github.com/python/cpython/blob/3.7/Lib/difflib.py

    Les docs ne sont jamais hors de synchronisation depuis les annotations sont assis à l'intérieur du code.

    OriginalL'auteur ItsmeJulian