python - Are there any standards (even IDE-specific) to refer a certain object from inside a comment string? -


in java, in eclipse @ least, there way refer class, inside code documentation. cool, if 1 refactored class (changed name or moved in other package), comment refactored.

i'm using pycharm, , i'd know if can same thing there.

for example:

def myfunction():     """does interesting class mypackage.myclass.      see yourpackage.yourclass     """     pass 

i'd ide recognize myclass , yourclass specified classes "are".

i know how type annotations so:

def myfunc(myarg):     """     :type myarg: classinthismodule     :rtype: int     """     return 3 

but not sufficient. want give examples in documentation, , link other areas in code might interesting (classes, functions, modules, etc), , want ide recognize these things, , refactor them intelligently in case that's needed.

is possible? or need write plugin if wanted this.


Comments

Popular posts from this blog

Payment information shows nothing in one page checkout page magento -

tcpdump - How to check if server received packet (acknowledged) -