cxref - 클라우드에서의 온라인

프로그램:

이름

cxref - C 상호 참조 및 문서화 도구입니다.

개요

cxref 파일 이름 [ ... 파일 이름] [-영형이름] [-N기본 이름] [-NS기본 이름] [-모든 댓글]
[-코멘트 없음] [-축어-설명] [-블록-댓글]
[-xref[-모두][-파일][-func][-var][-유형]] [-warn[-all][-comment][-xref]]
[-index[-all][-file][-func][-var][-type]] [-날것의] [-유액] [-html[-src]] [-rtf] [-sgml]
[-NS이름] [-NS밝히다] [-유밝히다] [-CPP cpp_프로그램] [-- cpp_args ... cpp_args]

cxref 파일 이름 [ ... 파일 이름] -지우다 [-영형이름] [-N기본 이름] [-NS기본 이름]

기술

C에 대한 문서와 상호 참조를 자동으로 생성할 수 있는 프로그램
프로그램)

입력은 적절한 주석이 포함된 C 프로그램이고 출력은 LaTeX, HTML, RTF 또는
SGML 파일.

옵션

파일 이름
문서화할 파일 이름, 한 번에 문서화할 수 있는 파일 수에는 제한이 없습니다.

-지우다
명명된 파일은 출력 디렉터리와 해당 항목에서 삭제됩니다.
상호 참조 데이터베이스와 기본 출력 파일이 제거됩니다.

-오디르이름
출력 라텍스 파일에 사용할 디렉토리 이름과 위치
생성된 상호 참조 파일입니다.

-N기본 이름
대신 출력 및 상호 참조 파일의 첫 번째 부분에 사용할 이름입니다.
cxref의 파일 확장자는 동일하게 유지됩니다.

-Rdirname
소스 파일이 둘 이상의 디렉터리에 있는 경우 dirname을 다음 이름으로 설정합니다.
소스 트리의 루트 디렉토리(쉬우면 상대 경로를 사용하십시오(예: `-R..)/ ..').
그런 다음 해당 루트 디렉토리에서 cxref를 실행하고 `-Odirname'은 다음과 같아야 합니다.
해당 디렉토리에 상대적입니다.

-모든 댓글
기존 의견이 효과가 있다고 생각하는 경우(위 설명 참조)
특별 코멘트). [위험! 이 옵션을 사용하면 이상한 결과가 나올 수 있습니다.]

-코멘트 없음
모든 주석을 무시합니다. 상호 참조만 원하는 경우 유용합니다.
선적 서류 비치.

- 축어-댓글
코드에 있는 주석이 미리 정해진 스타일로 포맷된 경우
출력에 보존하려는 항목이 있으면 이 옵션을 사용하면 해당 항목이 출력에 저장되지 않도록 강제됩니다.
재포맷되었습니다. [참고로 이는 파일 및 함수 설명에만 해당됩니다.]

-블록 주석
프로그램의 주석이 '블록' 스타일로 포맷된 경우(선행 문자 포함)
모든 줄의 '*' 문자), 이 옵션은 해당 문자를
산출. [단일 `*', `+', `|'에 대해 작동합니다. 또는 `:' 각 줄에.]

-xref 상호 참조 정보를 생성합니다(아래 참조).
-all 모든 상호 참조.
-file 파일에 대한 상호 참조.
-func 함수에 대한 상호 참조.
-var 변수에 대한 상호 참조.
-type 유형에 대한 상호 참조.

-경고하다 경고가 발생하면 옵션을 함께 연결해야 합니다.
-all 모든 경고.
-comment 누락된 댓글에 대해 경고합니다.
-xref 상호 참조가 누락되었음을 경고합니다.

-인덱스 상호 참조 색인을 생성하려면 옵션을 함께 연결해야 합니다.
-all 모든 인덱스.
-file 파일 인덱스.
-func 함수 색인입니다.
-var 변수 인덱스.
-type 유형의 색인입니다.

-노골적인 -warn을 제외하고는 실제로 많이 사용되지 않는 원시 형식의 출력을 생성합니다.

-유액 각 소스 파일과 추가 파일을 문서화하기 위해 LaTeX 파일을 생성합니다.
여기에는 이러한 각 파일이 포함됩니다.

-html 각 소스 파일과 기본 파일을 문서화하기 위해 HTML 4.01 파일을 생성합니다.
각 파일을 참조하세요.

-html-src
HTML 출력과 링크가 포함된 소스 파일의 HTML 버전을 생성합니다.

-rtf 소스 파일을 문서화하기 위해 서식 있는 텍스트 형식(RTF) 파일을 생성합니다.

-sgml 소스 파일을 문서화하기 위해 SGML 파일을 생성합니다. (LinuxDoc DTD 사용).

-Idirname
포함 파일의 경로를 지정하는 GCC 옵션입니다.

-Ddefine
전처리기 기호를 정의하는 GCC 옵션입니다.

-유데핀
전처리기 기호를 정의 해제하는 GCC 옵션입니다.

-CPP 프로그램
컴파일 시간 기본값 대신 사용할 프로그램 이름입니다. 프로그램
작동하려면 `gcc -E -C -dD'가 수행하는 모든 작업을 수행할 수 있어야 합니다. 만약에
프로그램은 인수를 취한 다음 전체 내용을 따옴표로 묶어야 합니다.
cxref에 대한 단일 인수로 해석됩니다.

--아르헨티나 ... 아르헨티나
전처리기에 전달될 추가 인수는 `--' 뒤에 위치할 수 있습니다.
분리 기호.

C 컴파일러 바꿔 놓음 cxref-cc
기존 소스 코드에서 cxref 사용을 단순화하기 위해 이제 다음을 수행하는 쉘 스크립트가 있습니다.
C 컴파일러를 호출한 다음 cxref를 호출하여 소스 파일을 처리합니다. 이는 다음을 의미합니다.
Makefile 등에서 CC를 대체하는 데 사용할 수 있습니다.

사용법: cxref-cc [일반적인 cc 옵션]

소스 파일의 이름은 옵션 목록과 `-D*'에서 추출됩니다.
`-I*', `-U*' 플래그를 사용하고 C 컴파일러가 성공적으로 종료되면 cxref가 호출됩니다. 그만큼
사용할 C 컴파일러의 이름은 CXREFCC 환경 변수에 의해 제어됩니다.
이것은 CC 환경 변수로 설정되지 않았거나 gcc에서만 실패했습니다.

이 스크립트를 사용하려면 옵션을 포함하는 `.cxref' 구성 파일을 사용해야 합니다.
C 컴파일러의 명령줄에 옵션을 넣을 곳이 없기 때문입니다.

이는 C 소스 파일만 상호 참조하고 문서화합니다.
그러나 컴파일된 항목과 상호 참조되는지 확인합니다.
올바른 옵션 등

Cxref 구성 입양 부모로서의 귀하의 적합성을 결정하기 위해 미국 이민국에
이러한 명령줄 인수는 파일 대신 `.cxref'라는 파일에 넣을 수도 있습니다.
명령줄. cxref가 실행될 때 프로그램에 대한 인수는
다음 순서.

(1) 명령줄에 있는 항목. (2) 현재 디렉토리의 `.cxref' 파일에 있는 것들.
(3) `-R'에 의해 지정된 소스 트리 루트의 `.cxref' 파일에 있는 것.

이는 다중 디렉토리 소스 트리에서 각 하위 디렉토리가 `.cxref'를 가질 수 있음을 의미합니다.
`-R..' 줄만 포함하거나 적절한 내용을 포함하는 파일입니다. 기본 디렉토리에는
나머지 옵션이 포함된 `.cxref' 파일입니다. 이는 필요성을 완전히 제거합니다.
소스 파일 이름 외에 명령줄에 옵션이 있어야 합니다.

`.cxref' 파일의 형식은 줄 수에 제한이 없으며 각 줄에는 단일 줄이 포함됩니다.
명령줄 인수(argv 중 하나와 동일) 유일하게 할 수 없는 옵션
소스 파일 자체의 이름과 '-delete' 옵션이 사용됩니다. 빈 줄은
무시되고 '#'으로 시작하는 줄은 주석입니다.

프로그램 문서 코멘트
프로그램에 대한 문서는 다음과 같은 코드의 주석으로 생성됩니다.
적절하게 형식화되었습니다. 상호 참조는 코드 자체에서 이루어지며 별도의 작업이 필요하지 않습니다.
추가 업무.

특수 주석은 `/**** ****/'(파일의 경우) 및 `/*++++ ++++*/'(데이터의 경우)입니다.
객체) 표준 `/*' 및 `*/' 주석 내부에는 `*' 또는 `+'를 원하는 만큼 사용할 수 있습니다.
주석의 구분 기호는 무시됩니다.

주석 줄이 공백으로 시작하고 뒤에 `+html+'가 오면 나머지 부분은
행은 HTML 출력에만 포함되며 HTML을 포함할 수 있도록 처리되지 않습니다.
마크업, `-html-'은 행의 나머지 부분이 HTML을 제외한 모든 항목에 포함됨을 의미합니다.
산출. 다른 출력 형식에도 동일하게 적용됩니다. 행에 '+none+'을 사용할 수 있습니다.
어떤 출력에도 나타나지 않습니다. 이에 대한 예외는 원시 출력이 어떤 작업도 수행하지 않는다는 것입니다.
확인하고 모든 라인을 출력합니다.

주석이 `,', `;' 뒤에 오는 모든 상황에서 또는 `)'는 공백으로만 구분되며
탭에서는 주석이 구두점 앞으로 푸시되어 해당 개체에 적용됩니다.

이 프로그램은 일부 GCC 확장이 포함된 전체 ANSI C 문법 파서를 사용하여 구현됩니다.
즉, 코드 스타일은 중요하지 않고 내용과 주석만 중요합니다.

Cross 참조
다음 항목에 대해 상호 참조가 수행됩니다.

파일
현재 파일이 포함된 파일
(다른 파일을 통해 포함된 경우에도)

#포함
현재 파일에 포함된 파일입니다.
이 파일 등에 포함된 파일

변수
외부 변수 정의 위치.
전역 변수를 볼 수 있는 파일입니다.
변수를 사용하는 파일/함수.

기능
함수의 프로토타입이 포함된 파일입니다.
함수가 호출하는 함수입니다.
함수를 호출하는 함수입니다.
함수를 참조하는 파일 및 함수입니다.
함수에 사용되는 변수입니다.

이러한 각 항목은 출력에서 ​​상호 참조됩니다.

상호 참조는 `cxref.variable', `cxref.function', `cxref.include' 파일을 사용하고
출력 디렉터리에 `cxref.typedef'가 있습니다. 다음은 기능의 전체 목록입니다.
프로그램에서 변수 사용법을 사용하여 함수 호출 계층을 생성하거나
예를 들어 가변 사용 다이어그램. 각 파일에 대해 두 개의 cxref 패스가 필요합니다.
상호 참조 파일을 구축하고 두 번째 파일을 사용합니다.

(`-N' 옵션을 사용하면 파일명이 달라진다.)

유액 산출
기본 LaTeX 출력은 하나의 추가 파일이 포함된 각 소스 파일에 대한 파일입니다.
다른 파일 각각을 포함하는 `cxref.tex'. 이는 makefile이 다음만 허용하도록 하기 위한 것입니다.
변경된 파일을 업데이트합니다(참조에 따라 모든 파일을 업데이트해야 할 수도 있음).
다시 확인했습니다). cxref.tex 파일이 작성되면 사용자가 수정할 수 있습니다.
추가되는 모든 새 파일은 소스 코드 섹션 끝에 추가되며 나머지 파일은
파일은 변경되지 않습니다.

색인은 `cxref.apdx.tex'라는 파일에 기록되고 cxref.tex는 참조하도록 업데이트됩니다.
그것.

또한 세 개의 LaTeX 스타일 파일 `page.sty', `fonts.sty' 및 `cxref.sty'가 작성되어 있습니다.
이는 페이지에 더 많은 내용이 표시될 수 있도록 더 작은 여백과 더 작은 글꼴을 사용하도록 설정합니다.
페이지를 만들고 cxref 출력을 조판하기 위한 새 명령을 정의합니다.

(`-N' 옵션을 지정하면 파일 이름 `cxref.tex'와 `cxref.apdx.tex'가 다릅니다.
사용 된.)

HTML 산출
기본 HTML 출력은 하나의 추가 파일이 포함된 각 소스 파일에 대한 파일입니다.
다른 파일 각각을 포함하는 `cxref.html'. 이는 makefile이 다음만 허용하도록 하기 위한 것입니다.
변경된 파일을 업데이트합니다(참조에 따라 모든 파일을 업데이트해야 할 수도 있음).
다시 확인했습니다). cxref.html 파일이 작성되면 사용자가 수정할 수 있습니다.
추가되는 새 파일은 목차 앞 부분에 추가되고 나머지 파일은
파일이 변경되지 않은 상태입니다.

색인은 `cxref.apdx.html'이라는 파일에 기록되고 cxref.html은 참조되도록 업데이트됩니다.
그것.

(`-N' 옵션을 지정하면 파일 이름 `cxref.html'과 `cxref.apdx.html'이 다릅니다.
사용 된.)

HTML 출력은 HTML 4.01 표준을 사용하며 모든 페이지의 유효성이 올바르게 검사됩니다.

RTF 산출
서식 있는 텍스트 형식은 Microsoft가 고안한 상당히 낮은 수준의 페이지 설명 형식입니다. 그것
다른 형식처럼 잘 정의되어 있고 이해하기 쉬운 표준은 아니지만
문서 교환에 인기가 있습니다.

각 소스 파일과 인덱스 파일에 대한 단일 출력 파일이 있습니다.

SGML 산출
SGML은 메타 언어이므로 레이아웃 요소를 정의해야 합니다.
정보를 제공합니다. cxref 출력은 LinuxDoc 문서 형식을 사용하며
SGMLtools 프로그램과 함께 사용하도록 설계되었습니다(http://www.sgmltools.org/).

각 소스 파일과 인덱스 파일에 대한 단일 출력 파일이 있습니다.

onworks.net 서비스를 사용하여 온라인으로 cxref 사용