2014-11-26 3 views
3

Очевидно, что здесь отсутствует нечто серьезное. Вот моя тестовая программа:Pydoc не видел docstrings?

""" 
Doc and nothing but doc 
""" 

class TestMe(object): 
    """ 
    class documentation goes here 
    """ 
    def testFunc(self): 
     """ 
     FunctionDoc Goes here 
     """ 
     print "Hello world" 

if __name__ =="__main__": 
    t=TestMe() 
    t.testFunc() 

Я запустил его, и он печатает «Hello world», natch. Но pydoc.py test.py дает это:

no Python documentation found for 'test.py' 

Очевидно я пропускаю что-то простое, но на что?

--edit-- предложение Per Вишну я добавил «print t.__doc__» до последней строки файла, и теперь запустив файл дает это:

Hello world 

    class documentation goes here 

Но pydoc до сих пор не нашли какой-либо документации.

+1

Пробовали ли вы 'TestMe .__ doc__'? –

+1

Вы пробовали решения, размещенные здесь? http://stackoverflow.com/questions/13040646/how-do-i-create-documentation-with-pydoc –

+0

Да, именно так я и посмотрел, прежде чем публиковать это. И почему мне кажется, что мой тестовый сценарий выше прав. –

ответ

9

Pydoc хочет имя модуля, а не имя файла. Попробуйте pydoc test.

Он будет использовать аргумент в качестве имени файла, если он имеет косую черту в нем: pydoc ./test.py

+0

Бинго! Я знал, что это должно быть что-то простое. –

Смежные вопросы