«documentation-generation» 태그된 질문

상징적 인“Given-When-Then”시나리오 구문을 사용한 행동 주도 개발 구문은 최근 소프트웨어 기능 평가를위한 경계 객체 로 사용하기에 상당히 절실했습니다 . Gherkin 또는 원하는 기능 정의 스크립트는 비즈니스에서 읽을 수있는 DSL 이며 이미 그와 같은 가치를 제공 한다는 데 동의합니다 . 그러나 나는 프로그래머가 아닌 사람들이 ( Martin Fowler 처럼 ) 쓸 …

24 documentation  bdd  documentation-generation  business-rules 

휴무 . 이 질문은 더 집중되어야 합니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 한 가지 문제에만 집중할 수 있도록 질문을 업데이트하십시오 . 작년에 문을 닫았 습니다 . 몇 달 후에 코드를 다시 읽고 탐색해야 할 필요성이 최소화되도록 코드를 문서화하고 싶습니다. 소스 코드와 외부, 시퀀스 …

22 documentation  code-reviews  documentation-generation  help-documentation 

그래서 우리는 이와 같은 인터페이스를 가지고 있습니다 /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary> void Bar(); } 최근에 우리는 위와 같이 많은 XML …

20 c#  documentation  xml  documentation-generation 

현재 두 가지 시스템을 사용하여 코드 문서를 작성하고 있습니다 (C ++ 사용). 메소드 및 클래스 멤버에 대한 문서는 Doxygen 형식을 사용하여 코드 옆에 추가됩니다. 서버에서 Doxygen은 소스에서 실행되므로 출력은 웹 브라우저에서 볼 수 있습니다 개요 페이지 (클래스 세트 설명, 애플리케이션 구조, 예제 코드 등)가 Wiki에 추가됩니다. 개인적 으로이 방법은 멤버와 …

13 documentation  documentation-generation  wiki 

메소드 또는 API가 코드베이스에 있지만 구현이 완료되지 않았거나 변경 될 가능성이 있으므로 사용해서는 안된다는 의미로 "deprecate"와 유사하지만 좋은 용어가 있습니까? (예, 그 방법은 공개되어서는 안됩니다. yada yada yada. 나는 상황을 만들지 않았으며 최선을 다하려고 노력하고 있습니다.) 사람들은 무엇을 제안합니까? 실험적이고 불완전한 다른 것? 여전히 유동적 인이 API에 대한 javadoc 문서를 …

12 documentation  terminology  api  documentation-generation  javadocs 

폐쇄되었습니다 . 이 질문은 더 집중되어야 합니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 한 가지 문제에만 집중할 수 있도록 질문을 업데이트하십시오 . 휴일 3 년 전 . 기본적으로 PHP로 개발되었으며 또 다른 일반 웹 응용 프로그램 인 웹 응용 프로그램을 완성했습니다. 일반적으로 최종 프로덕션 …

11 project-management  documentation  documentation-generation  projects-and-solutions 

에 대한 코드를 문서화 doxygen했지만 기본 HTML을 원하지 않습니다. GNOME처럼 사용자 정의 CSS, 헤더, 바닥 글 등을 제공하여 파일을 사용자 정의 할 수 있다는 것과 파일에 공통 PHP 코드를 추가하고 다른 이름으로 저장하도록 지시하는 방법을 알고 .php있지만 실제로는 원하는 것이 아닙니다. . 내가 원하는 것은 MSDN과 같은 출력입니다. 나는 그것을 …

10 documentation  templates  documentation-generation