Pythonのdocumentator、IDE

Question

が、私はそのような機能を持っていると仮定し、ガイド：

def render(someobject): 
someobject. #here i expect IDE to know which class it is and autocompletion and other IDE functional will be available 
dorender() 

私の場合はIDEは、そこに何が起こるのか知る方法がありません。 コメントを使用してどのように伝えますか？私が知っているとき

私はこの

/** 
* @param MyClass myobject 
**/ 
function render($myobject){ 
    //by typing $myobject-> IDE already knows, that it should use $myobject as MyClass objec 
    dorender() 
} 

別のユースケースのようなものを使用しましたPHPの場合は

は、いくつかのケースでは、いくつかのプロキシがいくつかのオブジェクト IDEが知ってする機会を持っていないが、私返すことであり、これをコメントで指定し、将来自分自身を助け、IDEを助けたいと思っています。 PHPで

私は次の操作を行いますPhpStormを使用しながら：

$myobject=some_proxy() 
/** 
* @var $my_object MyClass 
**/ 
// in following code IDE will use $myobject as MyClass 

どのように私はspecificaly PyCharmと同じ動作を実現し、共通のpython documentatorsことができますか？

Answer 1

はdocstringを使用します。

def render(someobject): 
    """ This methods renders some object. """ 
    dorender() 

詳しい情報は、あなたがオブジェクトのメソッドを知るためにイントロスペクションを使用することができ、ここでhttp://en.wikipedia.org/wiki/Docstring#Python

見つけることができ、属性など：

dir(object) 
help(object) 

イントロスペクションに基づく自動補完とIDE統合が可能です。 Python.orgウェブサイトで利用可能詳細情報：http://wiki.python.org/moin/IntegratedDevelopmentEnvironments

がsomeobjectは、あなたがtypeやisinstanceを使用することができるかを調べるために、以下の擬似コードを参照してください。私はそれが動作するかどうかわからない

type(someobject) 
if isinstance(someobject, ClassA): 
    print "someobject is a ClassA variable" 

Answer 2

をPyCharm（私はそれを使用しません）で - しかし、Python 3のためにfunction annotationsが追加されました。

あなたは、関数の定義の中にそれらを置くことができます。

def render(someobject :ObjectClass): 
    dorender() 

たぶんPyCharmはSomeObjectの上で使用可能なメソッドを定義するためにこれを使用します。

編集：私は、これは（すごいです）動作する必要がありますね小さな試験後

。