ford

포드

이것은 최신 Fortran 프로그램을위한 자동 문서 생성기입니다. 포드는 Fortran Documenter를 나타냅니다. 아시다시피, "To Ford"는 강 (또는 다른 물)을 건너는 것을 말합니다. 이 맥락에서 자동차와 관련된 회사 나 개인을 언급하지는 않습니다.

포드는 독소력의 포트란 처리가 좋지 않아서 비슷한 대안이 부족하여 작성되었습니다. Robodoc은 실제로 소스 코드에서 정보를 추출 할 수 없으며, 내가 찾은 다른 자동 문서 소프트웨어는 독점적이거나 Fortran에게는 잘 작동하지 않았거나 출력을 생성하는 방법에 대해 제한적이었습니다. F90doc은 상당히 훌륭하고 Fortran 2003의 대부분을 처리 할 수 ​​있도록 수정할 수 있었지만 다소 추악한 문서화를 생성하고, 내가 원하는만큼 문서의 다른 부분들 사이에 많은 링크를 제공 할 수 없으며, Perl로 작성되었습니다 (나는 친숙하지 않고 HTML 컨텐츠를 생산하기 위해 Python에서 발견 한 종류의 라이브러리가 부족합니다).

포드의 목표는 유익하고보기 좋은 최신 Fortran 소프트웨어에 대한 문서를 안정적으로 제작할 수 있다는 것입니다. 문서는 코드 내에서 쓰기 쉽고 객관적이지 않아야합니다. Doxygen만큼 기능이 풍부하지는 않지만 Ford는 Fortran 프로젝트를 문서화하기위한 좋은 대안을 제공 할 수 있기를 바랍니다.

기능

현재 기능은 다음과 같습니다.

• 소스 코드에서 변수, 절차, 절차 인수, 파생 유형, 프로그램 및 모듈에 대한 정보를 추출하는 기능.
• 소스 코드의 주석에서 문서를 추출하는 기능.
• Mathjax를 사용한 문서의 라텍스 지원.
• LUNR 검색을 사용하여 검색 가능한 설명서.
• 저자 설명 및 소셜 미디어 (Github 포함) 링크.
• 소스 코드를 다운로드하는 링크.
• 원시 형식 또는 구문 강조 표시와 함께 HTML에서 개별 파일에 대한 링크.
• 유형 세트 문서에 마크 다운 사용.
• 소프트웨어의 관련 부분 간의 링크.
• 문서를위한 부트 스트랩 CSS로 기능적이고 예쁘게 만듭니다.
• 구성 가능한 설정.
• 소스 코드의 특정 부분과 관련이없는 일반 정보가 포함 된 계층 적 페이지 세트를 작성하는 기능.
• 파일 레벨 문서 및 구문 강조 표시된 코드가있는 비 포르 란 소스 파일의 항목을 표시합니다.

설치

포드를 설치하는 가장 간단한 방법은 PIP를 사용하는 것입니다.

 pip install ford

PIP는 귀하를 위해 모든 종속성을 자동으로 처리합니다. 기본적으로 이것은 ford ~/.local/bin 에 배치합니다. PATH 에 추가해야 할 수도 있습니다.

또는 Ford는 Mac OS X의 Homebrew 패키지 관리자를 통해 이용할 수 있습니다.

 brew update
brew install FORD

Github에서 최신 개발 (마스터) 지점을 설치하려면 --HEAD 플래그 : brew install --HEAD FORD 추가하십시오.

Ford는 다음 명령을 실행하여 Spack 패키지 관리자를 통해 사용할 수 있습니다.

 spack install py-ford

선적 서류 비치

더 완전한 문서는 문서에서 찾을 수 있습니다.

특허

이 프로그램은 무료 소프트웨어입니다. Free Software Foundation, 라이센스의 버전 3 또는 이후 버전에서 게시 한 GNU 일반 공개 라이센스의 조건에 따라 재분배 및/또는 수정할 수 있습니다.

이 프로그램은 유용 할 것이지만 보증이 없다는 희망으로 배포됩니다. 상업성 또는 특정 목적에 대한 적합성 에 대한 묵시적 보증조차 없습니다. 자세한 내용은 GNU 일반 공개 라이센스를 참조하십시오.

이 프로그램과 함께 GNU 일반 공개 라이센스 사본을 받았어야합니다. 그렇지 않은 경우 GNU 웹 사이트를 참조하십시오.

포드가 제작 한 문서는 생산에 사용 된 입력에서 파생 된 파생물입니다. 이 라이센스의 영향을받지 않습니다.