docstring

6열

1답변

저는 파이썬을 배우기 시작했고 Emacs를 제 편집자로 사용하기 시작했습니다. 현재 Emacs는 일반 문자열 (작은 따옴표)과 문서 문자열 (삼중 따옴표)에 같은 색을 사용합니다. docstrings을 다른 색상으로 만들고 싶습니다. 그래서 'Options-> Emacs 사용자 정의'메뉴 옵션을 사용하여 'font-lock-doc-face'를 새로운 색상으

6열

1답변

emacs로 파이썬 docstring의 맞춤법을 검사하는 법?

가능한 경우 이맥스 내 파이썬 코드의 docstrings에서 맞춤법 검사기를 실행하고 싶습니다. 나는 ispell-check-comments 설정을 찾아 냈습니다.이 설정은 코드의 주석 만 맞춤법 검사에 사용할 수 있지만 상당히 파이썬 특정의 문서화 문자열 만 대상으로 할 수는 없습니다.

6열

4답변

파이썬 docstrings 바꾸기

나는 epytext에서 reST까지 마크 업 변환기를 작성했으며 이제는 epytext에서 reST 형식으로 전체 라이브러리의 모든 문서 문자열을 변환하려고합니다. 모듈의 모든 문서 문자열을 읽고 대체 코드를 다시 쓸 수있는 좋은 방법이 있습니까? ps : ast 아마도?

3열

1답변

문서 문자열을 문서화 된 함수와 분리하여 보관하는 방법이 있습니까?

많은 작은 함수를 가진 모듈을 만들고 있지만 문서화 문자열은 꽤 길다. docstrings은 실제 코드를 찾기 위해 긴 docstring을 끊임없이 스크롤해야하므로 모듈에 대한 작업을 짜증나게합니다. 문서화 문자열을 문서화 된 기능과 분리하여 보관할 수있는 방법이 있습니까? 나는 코드의 끝에서 파일의 끝에 docstring을 지정하거나, 심지어는 별개의 파

0열

4답변

소스 파일에서 문서를 생성하기위한 파이썬 솔루션

상당히 큰 프로젝트에는 많은 파이썬 (2.x) 소스 파일이 있습니다. 대부분은 문서화 또는 클래스/메소드의 시작 부분에있는 주석으로 잘 문서화되어 있습니다. 필자가 바라는 것은 파일을 읽고 거기에서 문서를 만드는 도구입니다. 클래스 상속, 메소드 이름 및 인수 및 추출 된 docstring/comments의 내용이 가장 좋습니다. 출력은 기술 문서로서 프로

4열

5답변

하나의 모듈/함수 등을위한 두 개 이상의 docstring?

파이썬 3.1을 사용하고 있습니다. 하나의 모듈 또는 함수에 대해 docstring을 두 개 이상 만들 수 있습니까? 나는 프로그램을 만들고 있는데, 각각에 대한 카테고리가있는 다중 문서화 문자열을 갖고 자한다. 프로그래머와 프로그래머가 아닌 다른 사람들도 쉽게 사용할 수 있도록 다른 사람들에게 프로그램을 제공하려고합니다. 프로그램 자체에 문서화를위한 참조

3열

3답변

docstrings의 반복적 인 내용

docstring의 반복적 인 내용을 처리하는 좋은 방법은 무엇입니까? docstring에서 설명해야하는 '표준'인수를 사용하는 많은 함수가 있지만, 유지 보수 및 업데이트가 훨씬 쉬우므로 docstring의 관련 부분을 한 번만 작성하면 좋을 것입니다. 내가 help(test)을 수행 할 때 내가 문서화 문자열이 표시되지 않기 때문에, arg_a = "a

3열

3답변

Python :이 문서 검사가 실패하는 이유는 무엇입니까?

doctest에있는이 코드는 그 자체로 실행될 때 작동하지만이 doctest에서는 10 개 장소에서 실패합니다. 나는 그것이 왜하는지 알 수 없다. class requireparams(object): """ >>> @requireparams(['name', 'pass', 'code']) >>> def complex_function

3열

2답변

구조화 파이썬 문서화 문자열, IDE 친화적 인 내가하는 PHPDoc 구문에 사용 된 PHP에서

: /** Do something useful @param first Primary data @return int @throws BadException */ function($first){ ... - 좀 짧은 유용한 참고 : 당신이 필요로하는 모든 단지 '그 무엇을?'호출 할 때 매우 편리합니다, 특히 타사 라이브러리 용. 또한 모든 IDE는

72열

3답변

파이썬에서 클래스 속성을 문서화하는 방법은 무엇입니까?

나는 속성이 공개적으로 액세스 할 수 있도록 의도 된 경량급 클래스를 작성 중이며 특정 인스턴스화에서 때로는 재정의되는 경우에만 가벼운 클래스를 작성합니다. Python 언어에는 클래스 속성 또는 모든 종류의 속성에 대한 docstring을 만드는 조항이 없습니다. 이러한 속성을 문서화하기 위해 허용되는 방법은 무엇입니까? class Albatross(ob