FpML Issues Tracker

385: Ban on floating comments

June 28, 2007

closed

Minor

Always

Architecture

Admin

andrew

Summary

Add a section to the Architecture document that prohibits the use of floating comments. xsd:annotation must be used instead.

Notes:

  • mgratacos

    06/29/07 9:32 am

    Sentence banning floating comments has been added to the Architecture Spec (between *), section on Annotations:

    Designers of FpML XML schemata SHOULD embed documentation within their schema components to enable the production of documentation automatically from the schema source. XML schema allows multiple annotations for each component differentiated by the ‘xml:lang’ attribute and designers MAY provide multi-lingual text. *Documentation MUST always be included within an xsd:annotation. ‘Floating’ documentation (or comments) is not allowed in the FpML schemata.*

    • Leave an update

    You must be logged in to post an update.

    Report an Issue

    The FpML Issues Tracker is designed to facilitate public interaction in the standard.

    By registering you will be able to submit corrections and comments, generate reports, and view the complete issues archive for FpML.

    Report Issue