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

Post a Comment

Popular posts from this blog

javascript - AngularJS custom datepicker directive -

i make custom datepicker directive custom template. but have no idea how start building it... how include date data directive? i appreciate guide or give me advice work on more precisely. it might you! follow below steps html code sample: <label>birth date</label> <input type="text" ng-model="birthdate" date-options="dateoptions" custom-datepicker/> <hr/> <pre>birthdate = {{birthdate}}</pre> <script type="text/ng-template" id="custom-datepicker.html"> <div class="enhanced-datepicker"> <div class="proxied-field-wrap"> <input type="text" ui-date-format="yy-mm-dd" ng-model="ngmodel" ui-date="dateoptions"/> </div> <label> <button class="btn" type="button"><i class="icon-calendar"></i>
Read more

javascript - jQuery date picker - Disable dates after the selection from the first date picker -

<!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>jquery ui datepicker - default functionality</title> <link rel="stylesheet" href="//code.jquery.com/ui/1.11.4/themes/smoothness/jquery-ui.css"> <script src="//code.jquery.com/jquery-1.10.2.js"></script> <script src="//code.jquery.com/ui/1.11.4/jquery-ui.js"></script> <link rel="stylesheet" href="/resources/demos/style.css"> <script> $(function () { $("#datepicker1").datepicker(); }); </script> <script> $(function () { $("#datepicker2").datepicker(); }); </script> </head> <body> <p>date 1: <input type="text" id="datepicker1"></p> <p>date 2: <input type="t
Read more