javadoc for Python 설명서 사용
저는 현재 파이썬으로 시작하고 있으며 PHP 배경이 강하며 PHP에서 사용하는 습관을 가지고 있습니다.javadoc문서 템플릿으로 사용할 수 있습니다.
혹시나 해서요..javadoc로서 그 자리를 차지하고 있습니다.docstring설명서를 Python으로 제공됩니다.여기서 확립된 협약 및/또는 공식 길드 가이드라인은 무엇입니까?
예를 들어 Python 사고방식에 맞추기에는 이와 같은 것이 너무 정교한가요? 아니면 가능한 한 간결하게 하려고 노력해야 할까요?
"""
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
"""
그리고 만약 제가 너무 철저하다면, 저는 대신에 이런 것을 해야 합니다 (대부분의 문서가 인쇄되지 않는 곳).__doc__방법)?
# 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)
구조화된 구조를 살펴봅니다.텍스트("reST"라고도 함) 형식은 일반 텍스트/docstring 마크업 형식이며 Python 세계에서 가장 널리 사용되는 형식입니다.그리고 reStructured에서 문서를 생성하는 도구인 Spinx를 반드시 살펴보아야 합니다.텍스트(예: Python 설명서 자체에 사용됨).스핑크스는 코드의 문서 문자열에서 문서를 추출할 수 있습니다(스핑크스.ext 참조).autodoc)를 지정하고 특정 규칙에 따라 reST 필드 목록을 인식합니다.이것은 아마도 가장 인기 있는 방법이 되었을 것입니다.
예는 다음과 같습니다.
"""Replace template placeholder with values.
:param timestamp: formatted date to display
:param priority: priority number
:param priority_name: priority name
:param message: message to display
:returns: formatted string
"""
또는 유형 정보로 확장됨:
"""Replace template placeholder with values.
:param timestamp: formatted date to display
:type timestamp: str or unicode
:param priority: priority number
:type priority: str or unicode
:param priority_name: priority name
:type priority_name: str or unicode
:param message: message to display
:type message: str or unicode
:returns: formatted string
:rtype: str or unicode
"""
Google Python 스타일 가이드를 따릅니다.스핑크스는 나폴레옹 확장자를 사용하여 이 형식을 구문 분석할 수도 있습니다. 이 확장자는 스핑크스 1.3과 함께 제공됩니다(이 확장자는 PEP257과도 호환됩니다).
def func(arg1, arg2):
"""Summary line.
Extended description of function.
Args:
arg1 (int): Description of arg1
arg2 (str): Description of arg2
Returns:
bool: Description of return value
"""
return True
위에 링크된 나폴레옹 문서에서 발췌한 예.
모든 유형의 문서 문자열에 대한 포괄적인 예입니다.
Python 문서화 문자열에 대한 표준은 Python Enhancement Proposal 257에 설명되어 있습니다.
당신의 방법에 대한 적절한 의견은 다음과 같습니다.
def format(...):
"""Return timestamp string with place holders replaced with values.
Keyword arguments:
timestamp -- the format string (default '')
priority -- priority number (default '')
priority_name -- priority name (default '')
message -- message to display (default '')
"""
"Python을 위한 문서 작성자 및 잠재적인 문서 작성자를 대상으로 하는" 페이지인 Documenting Python을 살펴보십시오.
간단히 말해서, 구조화됨텍스트는 Python 자체를 문서화하는 데 사용됩니다.개발자 가이드에는 reST 프라이머, 스타일 가이드 및 좋은 문서 작성을 위한 일반적인 조언이 포함되어 있습니다.
언급URL : https://stackoverflow.com/questions/5334531/using-javadoc-for-python-documentation
'programing' 카테고리의 다른 글
| 최신 TypeScript(v1.5로 추정) 예제에서 @(at 기호)는 무엇을 의미합니까? (0) | 2023.06.10 |
|---|---|
| LowerCase에 대한 NullPointeron이지만 나는 그 방법을 어디에서도 사용하지 않습니다. (0) | 2023.06.10 |
| SQL Server Reporting Services 보고서에 대체 행 색 추가 (0) | 2023.06.10 |
| 목록에 추가하는 것보다 목록 이해가 훨씬 빠른 이유는 무엇입니까? (0) | 2023.06.10 |
| Apache POI를 사용하여 내 xlsx 시트를 Java 개체로 변환하는 방법 (0) | 2023.06.10 |