Documentation Example

Java method documentation example:

/**
  * Constructs the string representation of the current instance
  *
  * Example:
  * <p><blockquote><pre>
  *     Object object = new Object();
  *     System.out.println(getStringRepresentation(object));
  * </pre></blockquote><p>
  *
  * This will output the string representation into the console.
  *
  * @param object An object
  * @return a string describing {@code object}
  * @see Object.toString
  */


Python method documentation example:
'''
Constructs the string representation of the current instance

Example usage:

>>> object = PythonClass()
>>> print(getStringRepresentation(object))
"Some text"

Parameters
------------
object : Any
    An object

Returns
--------
String
    A string describing the object


See Also
---------
Object.toString : Native way of getting the string representation of an instance

'''