여러 줄 주석을 작성하는 방법을 이미 알고 있으므로 삼중 작은 따옴표 또는 삼중 큰 따옴표를 사용할 수 있습니다. 필요할 때 문서를 얻을 수 있도록 기능을 설명할 때 문서 문자열을 사용합니다. 일부 IDE는 이름 위로 마우스를 가져가면 문서를 제공하고 일부는 특정 키워드를 강조 표시합니다. 그러나 사실 NumPy의 독스트링은 다른 언어보다 훨씬 유연합니다. Docstring은 함수 정의의 시작 부분에서 발생하는 문자열 리터럴입니다. 함수, 클래스 등의 경우 독스트링을 사용하면서 특정 값을 제공해야 합니다.
함수와 함께 독스트링을 사용할 때 인수를 전달해야 합니다. 클래스와 함께 사용할 때 속성과 메서드를 전달합니다. 모듈의 경우 클래스와 함수 목록을 제공해야 합니다. 패키지의 경우 기능이 있는 모듈 목록을 전달합니다. 따라서 기본적으로 docstring의 목적은 이름에서 알 수 있듯이 코드 문서화를 돕는 것입니다. 우리는 누군가가 미래에 우리 코드를 사용한다면 docstring의 도움으로 우리 코드와 우리 코드 이면의 논리를 이해할 수 있도록 문서화합니다. 내장 함수에는 독스트링도 있습니다. help() 함수를 사용하여 내장 함수의 독스트링을 볼 수 있습니다.
주석과 독스트링 사이에는 몇 가지 차이점이 있습니다. 주석은 인터프리터에서 무시되지만 독스트링은 인터프리터에서 무시되지 않습니다. 메모리는 독스트링에 할당됩니다. 주석은 코드에 대한 설명이지만 독스트링은 코드의 목적을 알려줍니다.
통사론:
NumPy에서 독스트링을 작성하는 구문은 다음과 같습니다.
'''독스트링 메시지'''
또는
'''독스트링 메시지'''
docstring은 함수나 메서드가 아니므로 적절한 구문이 없습니다. 여기서 주목해야 할 유일한 것은 독스트링을 세 개의 작은 따옴표 또는 세 개의 큰 따옴표로 시작한다는 것입니다. 코드에 대한 설명을 작성하고 끝에 세 개의 작은 따옴표 또는 세 개의 큰 따옴표로 다시 끝냅니다. 독스트링에 대해 작성해야 하는 필수 사항은 없습니다. 문자열 설명 앞뒤에 3개의 작은따옴표나 큰따옴표를 넣으면 됩니다.
예 1:
독스트링을 더 잘 이해하기 위해 예를 들어보겠습니다. 이 예제에서는 NumPy 라이브러리를 포함시킨 후 변수 'a'와 다른 변수 'b'를 선언하기만 하면 됩니다. 그 후, ''a' 및 'b' 변수를 추가하자'라는 독스트링을 생성합니다. 우리의 경우 이것은 쉬운 예이지만 코드가 복잡하면 코더가 코드를 이해하는 데 많은 도움이 됩니다. 그런 다음 변수 'a'와 'b'를 합산하고 출력 결과를 다른 변수 'c'에 저장합니다. 마지막으로 변수 'c'의 값을 출력합니다. 이제 코드를 실행합니다.
수입 numpy ~처럼 예를 들어ㅏ = 1
비 = 둘
'''와 b 변수를 추가하자'''
씨 = a+b
인쇄 ( 씨 )
이것은 주어진 코드 조각의 출력입니다. 시스템이 잘못된 구문에 대한 오류나 코드의 7행에 대한 오류를 제공하지 않았음을 알 수 있습니다. 또한 시스템은 독스트링을 인쇄하지 않았습니다. 대신, 우리가 시스템에 인쇄하도록 지시한 변수 'c'의 출력만 인쇄했습니다. 이것은 독스트링이 어떻게 작동하는지 보여줍니다. 다음에 새로운 코더가 우리 코드에 대해 작업을 시도할 때, 그는 우리가 독스트링의 도움을 받아 우리가 무엇을 하고 있는지 이해할 것입니다. 그러나 코드 사용자가 방해받지 않도록 출력으로 인쇄되지 않습니다.
예 2:
이제 우리는 독스트링의 작동을 이해하기 위해 복잡한 예제를 수행합니다. 먼저 NumPy 라이브러리를 포함하고 배열 초기화를 설명하는 다음 코드 줄을 설명하는 문서 문자열을 작성합니다. 또한 코드의 다른 부분에 독스트링을 추가합니다. 이제 독스트링을 추가하지 않고 이 코드를 새로운 Python 개발자와 공유하면 이 코드의 작업과 목적을 알기 어려울 것입니다. 그는 먼저 우리가 사용한 기능을 검색해야 합니다. 그러나 코드에 독스트링을 추가하면 다른 개발자가 함수에 대해 더 많이 공부하지 않고도 코드를 쉽게 이해할 수 있습니다. 우리는 몇 가지 제한 사항에 대해 의견을 추가하는 것으로 제한되지 않습니다. 주석은 한 줄 이상일 수 있습니다. 코드에서 두 번 이상 추가할 수도 있습니다. 그런 다음 NumPy를 np로 가져옵니다.
'''크기가 1x6인 배열을 전달할 변수 생성'''정렬 = 예를 들어 정렬 ( [ 열하나 , 22 , 33 , 44 , 55 , 66 ] )
'''배열을 tofile() 함수에 할당하여 arr이라는 파일에 저장할 수 있도록 합니다.'''
정렬 . 파일로 ( 'arr.bin' )
'''fromfile 함수를 사용하여 파일 표시'''
인쇄 ( 예를 들어 fromfile ( 'arr.bin' , dtype = 정수 ) )
다음 스니펫에서 볼 수 있듯이 독스트링은 출력에 표시되지 않으므로 코드의 출력이나 컴파일에 영향을 미치지 않습니다. Docstring은 컴파일 과정에서 무시됩니다.
결론
이 가이드에서는 NumPy의 독스트링에 대해 배웠습니다. 독스트링을 주석과 비교하고 둘의 차이점을 설명했습니다. 독스트링의 구문과 코드에서 독스트링을 작성하는 방법을 배웠습니다. 또한 NumPy의 독스트링이 무엇인지, 예제를 통해 어떻게 작동하는지 설명하려고 했습니다. 마지막으로 코더에게 필수적이라는 점을 언급했습니다. 우리는 NumPy에서 독스트링의 중요성을 반복하지 않을 것입니다. 우리는 당신이 당신의 코드에서 독스트링을 사용해야 한다고 말할 것입니다. NumPy에서 독스트링의 쓰기 스타일이 가장 인기 있는 스타일입니다. 프로그래밍 커뮤니티에서 코드의 작동 및 기능에 대해 서로에게 알리기 위해 널리 사용됩니다. 이 가이드는 NumPy 독스트링을 시작하는 데 도움이 될 것입니다. NumPy의 독스트링을 사용하여 필요한 대부분을 다루려고 했습니다.