title: Using javadoc for Python documentation
body: <p>I am currently beginning with Python and I have a strong PHP background and in PHP I have took the habit of using <code>javadoc</code> as a documentation template.</p>
  
  <p>I was wondering if <code>javadoc</code> has its place as <code>docstring</code> documentation in Python. <strong>What are the established conventions and/or official guildelines here?</strong></p>
  
  <p>E.g. is something like this too elaborate to fit in the Python mindset or should I try to be as concise as possible?</p>
  
  <pre><code>"""
  replaces template place holder with values
  
  @param string timestamp     formatted date to display
  @param string priority      priority number
  @param string priority_name priority name
  @param string message       message to display
  
  @return string formatted string
  """
  </code></pre>
  
  <p>And if I am a bit too exhaustive should I go with something like this instead (where most of the documentation doesn't get printed through the <code>__doc__</code> method)?</p>
  
  <pre><code># replaces template place holder with values
  #    
  # @param string timestamp     formatted date to display
  # @param string priority      priority number
  # @param string priority_name priority name
  # @param string message       message to display
  #    
  # @return string formatted string
  
  def format(self, timestamp = '', priority = '', priority_name = '', message = ''):
      """
      replaces template place holder with values
      """
      values = {'%timestamp%' : timestamp,
                '%priorityName%' : priority_name,
                '%priority%' : priority,
                '%message%' : message}
  
      return self.__pattern.format(**values)
  </code></pre>