docstring

2열

1답변

NumpyDoc DocStrings에 인수의 키워드 지정을 표시 하시겠습니까?

내 DocStrings에 대한 NumpyDoc 형식을 따르려고 시도 할 때 사용자에게 키워드 인수 (즉, SomeFunc(100)이 아닌 SomeFunc(theKeyWordArg=100)으로 지정됨)를 알리는 방법을 알 수 없습니다. 난 단지 키워드 인수 등 def somefunc(arg1, arg2): ''' Parameters ----------

5열

1답변

PyCharm docstrings을 클래스에 연결

IntelliJ IDEA를 사용하면 Java 문서 주석의 다른 메소드에 연결할 수 있습니다. 이를 통해 커서를 기호 위로 이동하고 키보드 단축키를 사용하여 정의로 점프 할 수있을뿐만 아니라 클릭 할 수있는 기호 아래에 밑줄을 표시하는 마우스를 가리키며 Ctrl 키를 누른 상태로 유지할 수 있습니다. 예 : /** * This is a link to

0열

2답변

Python : Docstring을 기반으로 HTML 출력 문서 생성

python docstrings을 기반으로 HTML 문서를 쉽게 출력 할 수 있습니까? 만약 그렇다면 어떻게해야합니까? HTML/CSS에 익숙하므로 출력 테마가 중요하지 않지만 기존 테마가 있으면 도움이됩니다. 코드가 업데이트 될 때마다 반복 될 수있는 프로세스가 필요합니다. 당신이

4열

3답변

큰 따옴표를 파이썬 docstring에 어떻게 저장할 수 있습니까?

문서 문자열에 저장하려는 큰 ASCII 로고가 있습니다. 이 로고는 3 개의 연속 된 큰 따옴표의 여러 인스턴스를 특징으로합니다. 크기와 복잡성은 개별 문자를 이스케이프 처리하는 것이 현실적인 선택이 아니라는 점에서 그렇습니다. 어떤 점에서도 3 줄의 연속 된 큰 따옴표가 한 줄로 나뉘어져 있지 않다는 점을 감안할 때이 로고를 어떻게 문서화 문자열에 저장할

1열

2답변

파이썬 2의 클래스에 대해 __doc__을 설정하십시오.

많은 수의 (100 개에 가까운) 클래스를 프로그래밍 방식으로 만들고 있는데 클래스의 문서 문자열을 설정할 수 있기를 원합니다. 각 클래스 docstrings은 채워질 특정 부분이있는 동일한 기본 구조를 갖습니다. 클래스를 만들 때 템플릿 문자열을 정의한 다음 클래스 별 인수로 채 웁니다. 난 후 나는 무엇을 인위적인 예는 생각으로 내가 help(A)를 호

9열

3답변

파이썬에서 다국어 문서화하는 방법

나 자신을 위해 새 모듈을 만들고 싶지만 일부 동료가이 모듈을 사용할 수 있기를 바랍니다. 나는 영어로 문서화 문자열을 작성하기 시작했으나이 언어를 잘 이해하지 못하는 사람들에게 모듈을 쓸모 없게 만들 것이라고 깨달았다. 첫 번째 아이디어는 영어와 동일한 문서 문자열에 스페인어를 입력하는 것이 었습니다. 그러나 이것이 옳지 않은 것 같습니다. 만약 러시아

3열

1답변

PyCharm의 모든 함수에 docstrings을 대량 추가 할 수 있습니까?

저는 많은 함수와 클래스에 docstring이 없다는 python 프로젝트가 있습니다. PyCharm이 자동으로 문서 문자열을 추가 할 수 있음을 알고 있습니다. 의도 동작을 사용하여 설명서 문자열 스텁 명령을 삽입하십시오. 그러나 많은 방법과 기능을 위해서는 지루합니다. 한 번에 모든 기능에 문서 문자열을 대량 추가하는 방법이 있습니까? 나는 필요한 것을

0열

1답변

numpydoc 규칙 : 방법은 클래스를 수정하지만 numpydoc의 문서화 문자열 규칙에 대한

질문을 아무 것도 반환하지 않습니다 : 나는 아무것도 돌려주지 않는 메소드를 포함하는 클래스를 가지고 있지만 클래스에 속성을 추가 할 수 있습니다. 예를 들어이 서투른 예에서 class MyClass(object): def __init__(self, a, b): self.a = a self.b = b return

1열

1답변

PyCharm에서 자동 완료 힌트를 위해 epytext를 사용하여 kwargs를 문서화하는 방법은 무엇입니까?

kwargs에 대한 추가 힌트를 얻을 수 있습니까? 사전 정의 된 가능한 키워드 인수의 예가 있습니까? 어쩌면 epytext가 그것을 지원하지 않을 수 있습니까? class Person(): def __init__(self, **kwargs): """ @param name: Name @type name: str

3열

1답변

python 함수를 강제로 docstring에서 매개 변수 유형

epydoc 및 Sphinx 문서 생성기는 모두 형식이 any/all 함수 매개 변수 중 무엇이어야하는지 주석을 달 수 있습니다. 내 질문은 : 거기가 문서화 문자열에을 문서화 할 때 은 (실행시) 이러한 유형을 적용하는 방식 (또는 모듈)입니다. 이것은 강력한 형식의 (컴파일 타임 검사)이 아니지만 회사 유형 (런타임 검사)이라고 할 수 있습니다. 어쩌면